getPubchemStatus: Retrieves the status of a PubChem request

In bhklab/AnnotationGx: AnnotationGx: A package for building, updating and querying an annotation database for pharmaco-genomic data

Retrieves the status of a PubChem request

Description

This function sends a request to PubChem to retrieve the status of a given URL. It returns the status code and, if specified, the parsed information from the response.

Usage

getPubchemStatus(
  returnMessage = FALSE,
  printMessage = TRUE,
  url = "https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/name/Aspirin/cids/JSON"
)

Arguments

returnMessage	Logical indicating whether to return the parsed information from the response.
printMessage	Logical indicating whether to print the status message.
url	The URL to send the request to. Default is "https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound/name/Aspirin/cids/JSON".

Value

The status code of the response. If returnMessage is TRUE, the parsed information from the response is also returned.

Examples

getPubchemStatus()
getPubchemStatus(returnMessage = TRUE)
getPubchemStatus(printMessage = FALSE)

bhklab/AnnotationGx documentation built on April 3, 2025, 4:27 p.m.