Skip to contents

Generate Data for Simulations

Source: R/generate-data.R
ssd_generate_data.Rd

A family of functions to generate a tibble of nested data sets.

Usage

ssd_generate_data(x, ...)

# S3 method for class 'data.frame'
ssd_generate_data(x, ..., replace = FALSE, nrow = 6L, nsim = 100L)

# S3 method for class 'fitdists'
ssd_generate_data(x, ..., dist = "top", nrow = 6L, nsim = 100L)

# S3 method for class 'tmbfit'
ssd_generate_data(x, ..., nrow = 6L, nsim = 100L)

# S3 method for class 'character'
ssd_generate_data(x, ..., pars = list(), nrow = 6L, nsim = 100L)

# S3 method for class '`function`'
ssd_generate_data(x, ..., args = list(), nrow = 6L, nsim = 100L)

Arguments

x

The object to use for generating the data.

...

Unused.

replace

A flag specifying whether to sample with replacement.

nrow

A integer vector of the number of rows in the generated data.

nsim

A count of the number of data sets to generate.

dist

A string specifying the distribution in the fitdists object or "top" to use the distribution with most weight or "multi" to treat the distributions as a single distribution.

pars

A named list of the parameter values.

args

A named list of the argument values.

Value

A tibble of nested data sets.

Methods (by class)

  • ssd_generate_data(data.frame): Generate data from data.frame

  • ssd_generate_data(fitdists): Generate data from fitdists object

  • ssd_generate_data(tmbfit): Generate data from tmbfit object

  • ssd_generate_data(character): Generate data using distribution name

  • ssd_generate_data(`function`): Generate data using function

Examples

ssd_generate_data(ssddata::ccme_boron, nrow = 5, nsim = 3)
#> # A tibble: 3 × 2
#>     sim data            
#>   <int> <list>          
#> 1     1 <tibble [5 × 1]>
#> 2     2 <tibble [5 × 1]>
#> 3     3 <tibble [5 × 1]>

fit <- ssdtools::ssd_fit_dists(ssddata::ccme_boron)
ssd_generate_data(fit, nrow = 5, nsim = 3)
#> # A tibble: 3 × 2
#>     sim data            
#>   <int> <list>          
#> 1     1 <tibble [5 × 1]>
#> 2     2 <tibble [5 × 1]>
#> 3     3 <tibble [5 × 1]>

fit <- ssdtools::ssd_fit_dists(ssddata::ccme_boron)
ssd_generate_data(fit[[1]], nrow = 5, nsim = 3)
#> # A tibble: 3 × 2
#>     sim data            
#>   <int> <list>          
#> 1     1 <tibble [5 × 1]>
#> 2     2 <tibble [5 × 1]>
#> 3     3 <tibble [5 × 1]>

ssd_generate_data("lnorm", nrow = 5, nsim = 3)
#> # A tibble: 3 × 2
#>     sim data            
#>   <int> <list>          
#> 1     1 <tibble [5 × 1]>
#> 2     2 <tibble [5 × 1]>
#> 3     3 <tibble [5 × 1]>

ssd_generate_data(ssdtools::ssd_rlnorm, nrow = 5, nsim = 3)
#> # A tibble: 3 × 2
#>     sim data            
#>   <int> <list>          
#> 1     1 <tibble [5 × 1]>
#> 2     2 <tibble [5 × 1]>
#> 3     3 <tibble [5 × 1]>