survey_sim: Simulate one or more survey design

View source: R/survey_sim.R

survey_simR Documentation

Simulate one or more survey design

Description

Simulate one or more survey design

Usage

survey_sim(
  design = c("NS_11", "SS_11", "SSR_11"),
  parasite = "hookworm",
  method = "kk",
  n_individ = seq(100, 1000, by = 10),
  scenario = survey_scenario(parasite),
  parameters = survey_parameters(design, parasite, method),
  iterations = 1000,
  cl = NULL,
  output = "summarised",
  analysis = "mean",
  check_memory = TRUE
)

Arguments

design

survey design(s) to use. Ignored if parameters and scenario are specified.

parasite

parasite(s) to use. Ignored if parameters and scenario are specified.

method

method(s) to use. Ignored if parameters and scenario are specified.

n_individ

number of individuals (can be a vector)

scenario

a data frame of scenarios (see survey_scenario)

parameters

a list of parameter sets (see survey_parameters)

iterations

number of iterations per simulation

cl

option to specify either a number of cores or an existing cluster for parallel computation (passed to pblapply)

output

type of output: one of summarised, full or extended

analysis

type of ERR/FECRT analysis: one of mean or delta

check_memory

should the expected memory allocation be checked before proceeding? Does not apply to output type summarised.

Examples

results <- survey_sim(design="NS_11", n_individ = c(100,200,300,400,500))


ku-awdc/eggSim documentation built on Feb. 23, 2024, 10:22 p.m.