param.global {simer} | R Documentation |
Global parameters generator
Description
Generate parameters for global options.
Usage
param.global(SP = NULL, ...)
Arguments
SP |
a list of all simulation parameters. |
... |
one or more parameter(s) for global options. |
Details
Build date: Apr 16, 2022 Last update: Jul 4, 2022
Value
the function returns a list containing
- $replication
the replication times of simulation.
- $seed.sim
simulation random seed.
- $out
the prefix of output files.
- $outpath
the path of output files, Simer writes files only if outpath is not 'NULL'.
- $out.format
'numeric' or 'plink', the data format of output files.
- $pop.gen
the generations of simulated population.
- $out.geno.gen
the output generations of genotype data.
- $out.pheno.gen
the output generations of phenotype data.
- $useAllGeno
whether to use all genotype data to simulate phenotype.
- $ncpus
the number of threads used, if NULL, (logical core number - 1) is automatically used.
- $verbose
whether to print detail.
Author(s)
Dong Yin
Examples
SP <- param.global(out = "simer")
str(SP)
[Package simer version 0.9.0.4 Index]