Package: ctxR 1.1.3.9000

Madison Feshuk

ctxR: Utilities for Interacting with the 'CTX' APIs

Access chemical, hazard, bioactivity, and exposure data from the Computational Toxicology and Exposure ('CTX') APIs <https://www.epa.gov/comptox-tools/computational-toxicology-and-exposure-apis>. 'ctxR' was developed to streamline the process of accessing the information available through the 'CTX' APIs without requiring prior knowledge of how to use APIs. Most data is also available on the CompTox Chemical Dashboard ('CCD') <https://comptox.epa.gov/dashboard/> and other resources found at the EPA Computational Toxicology and Exposure Online Resources <https://www.epa.gov/comptox-tools>.

Authors:Paul Kruse [aut], Caroline Ring [aut], Madison Feshuk [ctb, cre], Brianna Dirks [ctb], Carter Thunes [ctb], Jason Brown [ctb]

ctxR_1.1.3.9000.tar.gz
ctxR_1.1.3.9000.zip(r-4.7)ctxR_1.1.3.9000.zip(r-4.6)ctxR_1.1.3.9000.zip(r-4.5)
ctxR_1.1.3.9000.tgz(r-4.6-any)ctxR_1.1.3.9000.tgz(r-4.5-any)
ctxR_1.1.3.9000.tar.gz(r-4.7-any)ctxR_1.1.3.9000.tar.gz(r-4.6-any)
ctxR_1.1.3.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION |NEWS
card.svg |card.png
ctxR/json (API)

# Install 'ctxR' in R:
install.packages('ctxR', repos = c('https://usepa.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/usepa/ctxr/issues

Pkgdown/docs site:https://usepa.github.io

Datasets:

On CRAN:

Conda:

apicctecomptoxctxordresearch

8.32 score 21 stars 1 packages 33 scripts 696 downloads 127 exports 31 dependencies

Last updated from:f0e5d20267. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK212
source / vignettesOK246
linux-release-x86_64OK184
macos-release-arm64OK132
macos-oldrel-arm64OK120
windows-develOK183
windows-releaseOK143
windows-oldrelOK134
wasm-releaseOK158

Exports:check_existence_by_dtxsidcheck_existence_by_dtxsid_batchchemical_containschemical_contains_batchchemical_equalchemical_equal_batchchemical_starts_withchemical_starts_with_batchctx_keyctxR_hide_api_keyctxR_show_api_keyget_aggregate_records_by_dtxsidget_aggregate_records_by_dtxsid_batchget_aggregate_records_by_mediumget_aggregate_records_by_medium_batchget_all_assaysget_all_list_typesget_all_public_chemical_listsget_annotation_by_aeidget_annotation_by_aeid_batchget_bioactivity_detailsget_bioactivity_details_batchget_bioactivity_endpoint_statusget_bioactivity_summaryget_bioactivity_summary_batchget_biomonitoring_dataget_biomonitoring_data_batchget_cancer_hazardget_cancer_hazard_batchget_chem_infoget_chem_info_batchget_chem_props_expget_chem_props_exp_batchget_chem_props_predget_chem_props_pred_batchget_chem_props_summaryget_chemical_by_property_rangeget_chemical_by_property_range_batchget_chemical_detailsget_chemical_details_batchget_chemical_endpoint_statusget_chemical_imageget_chemical_image_batchget_chemical_lists_by_typeget_chemical_lists_by_type_batchget_chemical_molget_chemical_mol_batchget_chemical_mrvget_chemical_mrv_batchget_chemical_synonymget_chemical_synonym_batchget_chemical_weight_fractionget_chemical_weight_fraction_batchget_chemicals_in_listget_chemicals_in_list_batchget_chemicals_in_list_containget_chemicals_in_list_contain_batchget_chemicals_in_list_exactget_chemicals_in_list_exact_batchget_chemicals_in_list_startget_chemicals_in_list_start_batchget_demographic_exposure_predictionget_demographic_exposure_prediction_batchget_ecotox_hazard_by_dtxsidget_ecotox_hazard_by_dtxsid_batchget_exposure_endpoint_statusget_exposure_functional_useget_exposure_functional_use_batchget_exposure_functional_use_categoryget_exposure_functional_use_probabilityget_exposure_functional_use_probability_batchget_exposure_list_presence_tagsget_exposure_list_presence_tags_by_dtxsidget_exposure_list_presence_tags_by_dtxsid_batchget_exposure_product_dataget_exposure_product_data_batchget_exposure_product_data_pucget_fate_by_dtxsidget_fate_by_dtxsid_batchget_general_exposure_predictionget_general_exposure_prediction_batchget_general_use_keywordsget_general_use_keywords_batchget_genetox_detailsget_genetox_details_batchget_genetox_summaryget_genetox_summary_batchget_hazard_by_dtxsidget_hazard_by_dtxsid_batchget_hazard_endpoint_statusget_httk_dataget_httk_data_batchget_human_hazard_by_dtxsidget_human_hazard_by_dtxsid_batchget_inchiget_inchikeyget_lists_containing_chemicalget_lists_containing_chemical_batchget_medium_categoriesget_msready_by_dtxcidget_msready_by_dtxcid_batchget_msready_by_formulaget_msready_by_formula_batchget_msready_by_massget_msready_by_mass_batchget_msready_by_mass_with_error_batchget_product_use_categories_batchget_product_use_categoryget_production_volumeget_production_volume_batchget_public_chemical_list_by_nameget_public_chemical_list_by_name_batchget_reported_functional_useget_reported_functional_use_batchget_single_sample_records_by_dtxsidget_single_sample_records_by_dtxsid_batchget_single_sample_records_by_mediumget_single_sample_records_by_medium_batchget_skin_eye_hazardget_skin_eye_hazard_batchget_smileshas_ctx_keyhas_ctxR_optionhas_ctxR_optionsregister_ctx_api_keyset_ctxR_optionshowing_key

Dependencies:askpassclicpp11curldata.tabledplyrgenericsgluehttrjsonlitelifecyclemagrittrmimeopensslpillarpkgconfigpurrrR6Rcpprlangstringistringrsystibbletidyrtidyselecttriebeardurltoolsutf8vctrswithr

ctxR: Bioactivity API
Introduction | Bioactivity Assay Resource | Get annotation by aeid | Get all assay annotations | Bioactivity Data Resource | Get summary data | Get data | Conclusion

Last update: 2025-10-08
Started: 2025-01-23

ctxR: Utilities for Interacting with the CTX APIs in R
Introduction to the CCD | Searching one chemical at a time (single-substance search) | Batch search | Challenges of web-based dashboard search | Introduction to the CTX APIs | Authentication | Request Construction | Introduction to ctxR | Package Settings | API Key Storage | Quick Start Examples | Chemical API | Chemical Details Resource | Chemical Property Resource | Hazard API | Hazard Resource | Bioactivity API | Bioactivity Resource | Conclusion

Last update: 2025-10-06
Started: 2025-01-23

ctxR: Chemical API
Introduction | Chemical Details Resource | Get chemical data | By DTXSID | By DTXCID | By Batch Search | Pubchem Link to GHS classification | GHS classification | Chemical Property Resource | Chemical Fate Resource | Chemical Search Resource | By starting value | By exact value | By substring value | Subset for MS-Ready Structures | By Mass Range | By Chemical Formula | List Resource | Get all list types | All lists by type | List by name | Lists containing a specific chemical | DTXSIDs for chemical list and starting value | DTXSIDs for chemical list and exact value | DTXSIDs for chemical list and containing value | Chemicals in a specific list | Chemical File Resource | Get mrv by DTXSID or DTXCID | Get mol by DTXSID or DTXCID | Get structure image by DTXSID, DTXCID, or SMILES | Chemical Synonym Resource | Conclusion

Last update: 2025-10-06
Started: 2025-01-23

ctxR: Hazard API
Introduction | Hazard Resource | Get Hazard Data by DTXSID | Skin Eye Resource | Cancer Resource | Genetox Resource | Example Use Case: Comparing Hazard Data Across Chemical Lists | Obtain Lists of Chemicals | Review Genotoxicity Data for a Single Chemical | Review Genotoxicity Data for Chemical Lists | Conclusion

Last update: 2025-10-06
Started: 2025-01-23

ctxR: Exposure API
Introduction | Functional Use Resource | Functional Use | Functional Use Probability | Functional Use Probability Batch | Functional Use Categories | Product Data Resource | Product Data | Product Use Category Data | httk Data Resource | httk Data | List Presence Resource | List Presence Tags | List Presence Tag Data | Exposure Predictions | General Exposure Predictions | Demographic Exposure Predictions | Comptox Chemicals Dashboard (CCD) | Biomonitoring data | Chemical use and weight fractions | Multimedia Database (MMDB) | Medium Categories | Single Sample records | Aggregate Records | Batch Search | Conclusion

Last update: 2025-10-06
Started: 2025-01-23

Readme and manuals

Help Manual

Help pageTopics
Bioactivity API Server urlbioactivity_api_server
Check API keycheck_api_key
Check existence by DTXSIDcheck_existence_by_dtxsid
Check existence by DTXSID batchcheck_existence_by_dtxsid_batch
Chemical API Server urlchemical_api_server
Chemical containschemical_contains
Chemical contains batch searchchemical_contains_batch
Chemical equalchemical_equal
Chemical equal batch searchchemical_equal_batch
Chemical starts withchemical_starts_with
Chemical starts with batch searchchemical_starts_with_batch
ctxR OptionsctxR_options has_ctxR_option has_ctxR_options set_ctxR_option
Exposure API Server urlexposure_api_server
Get aggregate records by DTXSIDget_aggregate_records_by_dtxsid
Get Aggregate Records by DTXSID via batchget_aggregate_records_by_dtxsid_batch
Get aggregate records by mediumget_aggregate_records_by_medium
Get Aggregate Records by medium via batchget_aggregate_records_by_medium_batch
Retrieve all assaysget_all_assays
Get all list typesget_all_list_types
Get all public chemical listsget_all_public_chemical_lists
Retrieve annotations for AEIDget_annotation_by_aeid
Retrieve annotations for AEID batchget_annotation_by_aeid_batch
Retrieve bioactivity data from DTXSID, AEID, SPID, or m4idget_bioactivity_details
Retrieve bioactivity data from DTXSID or AEID batchget_bioactivity_details_batch
Bioactivity API Endpoint statusget_bioactivity_endpoint_status
Retrieve bioactivity summary for AEIDget_bioactivity_summary
Retrieve bioactivity summary data from AEID batchget_bioactivity_summary_batch
Get Biomonitoring dataget_biomonitoring_data
Get biomonitoring data via batchget_biomonitoring_data_batch
Get cancer hazardget_cancer_hazard
Get cancer hazard batchget_cancer_hazard_batch
Retrieve chemical informationget_chem_info
Retrieve chemical information in batch searchget_chem_info_batch
Get experimental physical-chemical property dataget_chem_props_exp
Get experimental physical-chemical property data via batchget_chem_props_exp_batch
Get predicted physical-chemical property dataget_chem_props_pred
Get predicted physical-chemical property data via batchget_chem_props_pred_batch
Get Summary information on chemical propertiesget_chem_props_summary
Get chemicals by property and its value rangeget_chemical_by_property_range
Retrieve chemicals by property and value range in batch searchget_chemical_by_property_range_batch
Retrieve chemical details from DTXSID of DTXCIDget_chemical_details
Retrieve chemical details from DTXSID of DTXCID in batch searchget_chemical_details_batch
Chemical API Endpoint statusget_chemical_endpoint_status
Get image file by DTXSID or DTXCIDget_chemical_image
Get image file by DTXSID or DTXCID batchget_chemical_image_batch
Get chemical lists by typeget_chemical_lists_by_type
Get chemical lists by type batch searchget_chemical_lists_by_type_batch
Get mol file by DTXSID or DTXCIDget_chemical_mol
Get mol file by DTXSID or DTXCID batchget_chemical_mol_batch
Get mrv file by DTXSID or DTXCIDget_chemical_mrv
Ger mrv file by DTXSID or DTXCID batchget_chemical_mrv_batch
Get chemical synonymget_chemical_synonym
Get chemical synonym batchget_chemical_synonym_batch
Get Chemical Weight Fractionsget_chemical_weight_fraction
Get chemical weight fraction via batchget_chemical_weight_fraction_batch
Get chemicals in a given chemical listget_chemicals_in_list
Get chemicals in a given chemical list batchget_chemicals_in_list_batch
Get chemicals in a list specified by contained charactersget_chemicals_in_list_contain
Get chemicals in a list specified by characters contained batch searchget_chemicals_in_list_contain_batch
Get chemicals in a list specified by exact charactersget_chemicals_in_list_exact
Get chemicals in a list specified by exact characters batch searchget_chemicals_in_list_exact_batch
Get chemicals in a list specified by starting charactersget_chemicals_in_list_start
Get chemicals in a list specified by starting characters batch searchget_chemicals_in_list_start_batch
Get demographic exposure prediction dataget_demographic_exposure_prediction
Retrieve demographic exposure predictions for chemicals via batchget_demographic_exposure_prediction_batch
Exposure API Endpoint statusget_exposure_endpoint_status
Retrieve exposure related functional use dataget_exposure_functional_use
Retrieve exposure related functional use data batchget_exposure_functional_use_batch
Retrieve functional use categoriesget_exposure_functional_use_category
Retrieve probability of exposure for functional use categoryget_exposure_functional_use_probability
Retrieve exposure functional use probability data batchget_exposure_functional_use_probability_batch
Retrieve list presence tagsget_exposure_list_presence_tags
Retrieve document data and list presence tags for a chemicalget_exposure_list_presence_tags_by_dtxsid
Retrieve document data and list presence tags for chemicals batchget_exposure_list_presence_tags_by_dtxsid_batch
Retrieve product data for exposure purposesget_exposure_product_data
Retrieve product data for exposure purposes batchget_exposure_product_data_batch
Retrieve product use categories related to exposureget_exposure_product_data_puc
Get fate by DTXSIDget_fate_by_dtxsid
Retrieve chemical fate data in batch searchget_fate_by_dtxsid_batch
Get general exposure prediction dataget_general_exposure_prediction
Retrieve general exposure predictions for chemicals via batchget_general_exposure_prediction_batch
Get General Use Keywordsget_general_use_keywords
Get general use keywords via batchget_general_use_keywords_batch
Get genetox detailsget_genetox_details
Get genetox details batchget_genetox_details_batch
Get genetox summaryget_genetox_summary
Get genetox summary batchget_genetox_summary_batch
Get hazard data by DTXSIDget_hazard_by_dtxsid
Get hazard data by DTXSID batchget_hazard_by_dtxsid_batch
Hazard API Endpoint statusget_hazard_endpoint_status
Get httk dataget_httk_data
Retrieve httk data via batch searchget_httk_data_batch
Get InChIget_inchi
Get InChIKeyget_inchikey
Get chemical lists containing given chemicalget_lists_containing_chemical
Get chemical lists containing given chemical batchget_lists_containing_chemical_batch
Retrieve MMDB medium categoriesget_medium_categories
Get msready by DTXCIDget_msready_by_dtxcid
Get msready by DTXCID batch searchget_msready_by_dtxcid_batch
Get msready by formulaget_msready_by_formula
Get msready by formula batch searchget_msready_by_formula_batch
Get msready by massget_msready_by_mass
Get ms ready by mass batch searchget_msready_by_mass_batch
Get msready by mass and error offsetget_msready_by_mass_with_error_batch
Get Product Use categories via batchget_product_use_categories_batch
Get Product Use Categoriesget_product_use_category
Get Production Volumeget_production_volume
Get Production Volume data via batchget_production_volume_batch
Get chemical list by nameget_public_chemical_list_by_name
Get chemical list by name batchget_public_chemical_list_by_name_batch
Get Reported Functional Useget_reported_functional_use
Get reported functional use via batchget_reported_functional_use_batch
Get single sample records by DTXSIDget_single_sample_records_by_dtxsid
Get Single Sample Records by DTXSID via batchget_single_sample_records_by_dtxsid_batch
Get single sample records by mediumget_single_sample_records_by_medium
Get Single Sample Records by medium via batchget_single_sample_records_by_medium_batch
Get skin and eye hazardget_skin_eye_hazard
Get skin and eye hazard batchget_skin_eye_hazard_batch
Get Smilesget_smiles
Hazard API Server urlhazard_api_server
Register CTX API Key for ctxRctxR_hide_api_key ctxR_show_api_key ctx_key has_ctx_key print.ctx_credentials register_ctx_api_key showing_key