get_cids {PubChemR} | R Documentation |
Retrieve Compound IDs (CIDs) from PubChem
Description
This function sends a request to PubChem to retrieve Compound IDs (CIDs) for given identifier(s).
Usage
get_cids(
identifier,
namespace = "name",
domain = "compound",
searchtype = NULL,
options = NULL
)
Arguments
identifier |
A vector of identifiers, either numeric or character.
The type of identifier depends on the |
namespace |
A character string specifying the namespace of the identifier. Possible values depend on the - For - For - For For more details, see the Input section of the PUG REST API. |
domain |
A character string specifying the domain of the query. Possible values are: - - - - Other domains as specified in the API documentation. |
searchtype |
An optional character string specifying the search type. Possible values depend on the Examples include: - - If |
options |
A list of additional options for the request. Available options depend on the specific request and the API. Examples include: - For similarity searches: - For substructure searches: If For more details, see the Structure Search Operations section of the PUG REST API. |
Details
For more detailed information, please refer to the PubChem PUG REST API documentation.
Value
An object of class 'PubChemInstance_CIDs', which is a list containing information retrieved from the PubChem database. Compound IDs can be extracted from the returned object using the CIDs function.
Note
To extract compoud IDs from returned object, one may use CIDs function. See examples.
See Also
Examples
compound <- get_cids(
identifier = "aspirin",
namespace = "name"
)
compound
# Extract compound IDs.
CIDs(compound)