
# faux <a href="https://www.scienceverse.org/faux/"><img src="man/figures/logo.png" align="right" height="120" /></a>

<!-- rmarkdown v1 -->

<!-- README.md is generated from README.Rmd. Please edit that file -->

<!-- badges: start -->

[![DOI](https://zenodo.org/badge/163506566.svg)](https://zenodo.org/badge/latestdoi/163506566)
[![CRAN
status](https://www.r-pkg.org/badges/version-last-release/faux)](https://CRAN.R-project.org/package=faux)
![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/faux)
[![Lifecycle:
stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![Coverage
status](https://codecov.io/gh/scienceverse/faux/branch/master/graph/badge.svg)](https://app.codecov.io/github/scienceverse/faux?branch=master)
[![R-CMD-check](https://github.com/scienceverse/faux/workflows/R-CMD-check/badge.svg)](https://github.com/scienceverse/faux/actions)
[![R-CMD-check](https://github.com/scienceverse/faux/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/scienceverse/faux/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

It is useful to be able to simulate data with a specified structure. The
`faux` package provides some functions to make this process easier. See
the [package website](https://www.scienceverse.org/faux/) for more
details.

## Installation

You can install the released version of faux from
[CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("faux")
```

And the development version from
[GitHub](https://github.com/scienceverse/faux) with:

``` r
# install.packages("devtools")
devtools::install_github("scienceverse/faux")
```

Please note that the ‘faux’ project is released with a [Contributor Code
of
Conduct](https://github.com/scienceverse/faux/blob/master/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.
