PugView-classes: Classes for Pug View Request

In PubChemR: Interface to the 'PubChem' Database for Chemical Data Retrieval

Classes for Pug View Request

Description

The Pug View API of PubChem database returns more detailed information about a PubChem request, such as assays, compounds, substances, etc. A super-class PugViewInstance is defined, which is returned from get_pug_view function. This class has slots detailed below.

Slots

results:

A list containing elements of each of the requested compounds, assays, substances, etc.

request_args:

A list containing the input arguments of a PubChem request.

success:

A logical value indicating whether the request was successfully completed (TRUE) or not (FALSE).

error:

A list detailing any errors encountered during the request, if applicable.

Note

Pug View API returns many section about the requested instance, which includes detailed information from PubChem database. There may be many nested sections, where each contains details about different features of the instance requested. These sections can be listed via sectionList function.

Other classes, called PugViewSectionList and PugViewSection, are defined to control the outputs of available sections and sub-sections returned from get_pug_view. See related functions for details.

See Also

section, sectionList

PubChemR documentation built on April 4, 2025, 2:18 a.m.