get_mass_batch_queryId_status: GET the status for a mass batch query from ChemSpider
In NIVANorge/chemspiderapi: R Wrapper for ChemSpider's API Services

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/FILTERING-get_mass_batch_queryId_status.R

This function is used to return the status of a query from post_mass_batch().

get_mass_batch_queryId_status(
  queryId,
  count = TRUE,
  message = TRUE,
  apikey,
  coerce = FALSE,
  simplify = FALSE
)

`queryId`	A valid 36-character ChemSpider query ID obtained from `post_mass_batch()`.
`count`	`logical`: Should the count of the results be returned (ChemSpider default)?
`message`	`logical`: Should the message be returned (ChemSpider default)?
`apikey`	A 32-character string with a valid key for ChemSpider's API services.
`coerce`	`logical`: should the list be coerced to a `data.frame`? Defaults to `FALSE`.
`simplify`	`logical`: should the results be simplified to a `vector`? Defaults to `FALSE`.

Call this endpoint with a queryId obtained from post_mass_batch().

If the query is still ongoing, returns a warning and a character vector of the query status as Incomplete. It is recommended to wait at least ten seconds before checking the status again.

If the query is finalized, returns a data frame of the query status with status, count and message. The status can be either Complete, Suspended, Failed, or Not Found.

Says ChemSpider:

"A status of Suspended can be caused if the results could not be compiled within a reasonable amount of time. Create a new filter request with more restrictive parameters.

A status of Failed can be caused if the backend system could not compile the results. Create a new filter request and, if the same outcome occurs, apply more restrictive parameters.

A status of Not Found can be caused if the Query ID has not been registered or has expired. Create a new filter request."

If both count and message are set to FALSE, get_mass_batch_queryId_status() returns the status as character vector.

If the status is Complete, the results of the query can be obtained from get_mass_batch_results().

This function is fully tidyverse compatible, e.g., for use in map_chr().

Returns the query status as list, data.frame or character vector.

Raoul Wolf (https://github.com/RaoulWolf/)

https://developer.rsc.org/compounds-v1/apis/get/filter/mass/batch/{queryId}/status

## Not run: 
## Get the status of a mass batch query from ChemSpider
queryId <- "a valid 36-character ChemSpider queryId"
apikey <- "a valid 32-character ChemSpider apikey"
get_mass_batch_queryId_status(queryId = queryId, apikey = apikey)
## End(Not run)