tcplLoadChemList: Load chemical list information

In tcpl: ToxCast Data Analysis Pipeline

Load chemical list information

Description

tcplLoadChemList queries the tcpl databases and returns information about the chemical lists.

Usage

tcplLoadChemList(field = NULL, val = NULL)

Arguments

field	Character of length 1, 'chid', 'dsstox_substance_id' or 'list_acronym', whether to search by chemical id (chid), dsstox_substance_id, or list_acronym
val	The values to query on

Details

Chemicals are stored in different lists by chemical ID. Therefore, it is not possible to delineate samples with the same chemical ID into two distinct chemical lists. However, it is possible for a chemical ID to belong to more than one (or no) chemical lists.

When chemicals belong to more than one list, the chemical is listed multiple times (one for each distinct list).

Value

A data.table with the chemical list information for the given parameters.

Examples

## Not run: 
## Passing no parameters gives all of the chemical IDs that have a chemical
## list registered
clist <- tcplLoadChemList()

## Notice there are different number of rows in tcplLoadChemList than in tcplLoadChem, 
## indicating some chemicals must belong to more than list (or no lists).
chem <- tcplLoadChem(include.spid = TRUE)
nrow(chem)
nrow(clist)


## Show the unique chemical lists
clist[ , unique(list_acronym)]

## Specifying a chemical list will not show what other libraries a 
## chemical might belong to.
tcplLoadChemList(field = "list_acronym", val = "CPDBAS")
tcplLoadChemList(field = "chid", val = 20182)
tcplLoadChemList(field = "dsstox_substance_id", val = "DTXSID7020182")

## End(Not run)

tcpl documentation built on Oct. 10, 2024, 1:07 a.m.