simulate_qt: Simulate a quantitative trait

View source: R/simulate_qt.R

simulate_qtR Documentation

Simulate a quantitative trait

Description

Simulate a quantitative trait

Usage

simulate_qt(
  simulate_qt_params,
  n_individuals,
  temp_sim_filename = get_plinkr_tempfilename(),
  plink_options = create_plink_options(),
  verbose = FALSE
)

Arguments

simulate_qt_params

the parameters for a quantitative traits simulation, as can be created by create_simulate_qt_params

n_individuals

the number of individuals. Use check_n_individuals to check if this is a valid value

temp_sim_filename

temporary file to store simulation parameters, which is a PLINK .sim file

plink_options

options to run PLINK, as created by create_plink_options

verbose

the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Note

This function is named after the --simulate-qt PLINK flag.

Author(s)

Richèl J.C. Bilderbeek


richelbilderbeek/plinkr documentation built on March 25, 2024, 3:18 p.m.