Learn R Programming

httk (version 2.6.0)

gen_input_params: Generate and store population values of time-dependent input variables

Description

Generates and stores a population using create_mc_samples for reference by get_input_param_timeseries. Specifically, this function generates parameters for a sample population and stores those parameters which are listed in the specified model's input.var.names.

Usage

gen_input_params(
  model,
  chem.cas = NULL,
  chem.name = NULL,
  dtxsid = NULL,
  samples = 10000,
  httkpop.dt = NULL,
  httkpop.generate.arg.list = list(nsamp = 10000, method = "direct resampling"),
  seed = NULL,
  input.param.dir = NULL
)

Arguments

model

A model which incorporates time-dependent parameters as specified in the model.list[[model]]$input.var.names.

chem.cas

Chemical Abstract Services Registry Number (CAS-RN) -- the chemical must be identified by either CAS, name, or DTXISD

chem.name

Chemical name (spaces and capitalization ignored) -- the chemical must be identified by either CAS, name, or DTXISD

dtxsid

EPA's 'DSSTox Structure ID (https://comptox.epa.gov/dashboard) -- the chemical must be identified by either CAS, name, or DTXSIDs

samples

Size of the stored population; default 10000. Overridden by the size of httkpop.dt, if specified, or by nsamp in httkpop.generate.arg.list, if specified.

httkpop.dt

A data table generated by httkpop_generate. This defaults to NULL, in which case httkpop_generate is called to generate this table.

httkpop.generate.arg.list

Arguments passed to httkpop_generate for generating a population if httkpop.dt is not specified. Defaults to list(nsamp = 10000, method = "direct resampling").

seed

Sets a seed for repeatable generation of populations. Defaults to null, in which case no seed is set.

input.param.dir

The path to the input_params_data_files directory, which is used to store all input_param data files. If input_params_data_files does not exist, this function will create it in the specified path. Default NULL, in which case the present working directory is used as default.

Author

Colin Thomson

Details

This function has no output; it writes (or re-writes) an Rds file in httk/data of the form input_params_<model>_<CAS>.Rds where <model> and <CAS> are the model name and chemical CAS, respectively.

See Also

get_input_param_timeseries