Skip to contents

Chemical starts with

Source: R/chemical-APIs.R
chemical_starts_with.Rd

Chemical starts with

Usage

chemical_starts_with(
  word = NULL,
  API_key = NULL,
  Server = chemical_api_server,
  verbose = FALSE,
  top = NULL
)

Arguments

word

A character string of a chemical identifier or portion of a chemical identifier. Identifiers can be a chemical name, dtxsid, dtxcid, casrn, or inchikey.

API_key

The user-specific API key

Server

The root address for the API endpoint

verbose

A logical indicating if some “progress report” should be given.

top

The number of results to return if there are multiple results available

Value

A data.frame of chemicals and related values matching the query parameters

Author

Paul Kruse, Kristin Issacs

Examples

if (FALSE) { # has_ctx_key() & is.na(ctx_key() == "FAKE_KEY")
# Pull chemicals that start with a fragment DTXSID
dtxsid_fragment <- chemical_starts_with(word = 'DTXSID702018')
}