check_model: Check for sufficient model parameters

View source: R/check_model.R

check_modelR Documentation

Check for sufficient model parameters

Description

This function halt model evaluation if not all the needed parameters (as specified in the modelinfo_[MODEL].r file) are available. The function uses get_cheminfo, so if the chemical has been checked against that function already then evaluation should proceed as expected. If you do not have the parameters you need and are using a non-human species try default.to.human = TRUE (there are many more values for human than any other species). If working in human, try first using load_dawson2021, load_sipes2017, or load_pradeep2020.

Usage

check_model(
  chem.name = NULL,
  chem.cas = NULL,
  dtxsid = NULL,
  model = NULL,
  species = NULL,
  class.exclude = TRUE,
  default.to.human = FALSE
)

Arguments

chem.name

Chemical name (spaces and capitalization ignored) – if parameters is not specified then the chemical must be identified by either CAS, name, or DTXISD

chem.cas

Chemical Abstract Services Registry Number (CAS-RN) – if parameters is not specified then the chemical must be identified by either CAS, name, or DTXISD

dtxsid

EPA's DSSTox Structure ID (https://comptox.epa.gov/dashboard) – if parameters is not specified then the chemical must be identified by either CAS, name, or DTXSIDs

model

Model to be checked, modelinfo files specify the requrements of each model.

species

Species desired (either "Rat", "Rabbit", "Dog", "Mouse", or default "Human").

class.exclude

Exclude chemical classes identified as outside of domain of applicability by relevant modelinfo_[MODEL] file (default TRUE).

default.to.human

Substitutes missing fraction of unbound plasma with human values if true.

Value

Stops code from running if all parameters needed for model are not available, otherwise does nothing.

Author(s)

john Wambaugh

See Also

get_cheminfo


httk documentation built on Sept. 11, 2024, 9:32 p.m.