Skip to content

rgsrs

0.1.0Package record

Query the FDA Global Substance Registration System (GSRS) API

0packages depend
1Kdownloads / year
80.0%test coverage
13/13flavors OK

Overview

About

Provides functions to query the FDA Global Substance Registration System (GSRS) REST API (https://gsrs.ncats.nih.gov/api/v1/). Enables programmatic access to substance records, UNII identifiers, synonyms, external codes, and chemical structures for over 170,000 registered substances.

Changes in 0.1.0

New functions

  • gsrs_search(): free-text and Lucene-syntax search across GSRS substances, with optional automatic pagination.
  • gsrs_substance(): fetch substance metadata by UNII (vectorized).
  • gsrs_names(): retrieve all registered names / synonyms for one or more UNIIs.
  • gsrs_codes(): retrieve all cross-reference codes (CAS, PubChem, ChEMBL, WHO-ATC, DrugBank, etc.) for one or more UNIIs, with optional code_system filter.
  • gsrs_unii_from_name(): resolve substance names to their UNII identifiers.
  • gsrs_structure(): fetch chemical structure data (SMILES, formula, MW, InChI, stereo info) by UNII.
Show all changes in 0.1.0Hide the rest of the changes in 0.1.0
  • gsrs_structure_search(): substructure, similarity, exact, and flexible structure search by SMILES.
  • gsrs_chem_info(): retrieve chemical structure information from any identifier — name, CAS, UNII, InChIKey, or SMILES.
  • gsrs_hierarchy(): retrieve the parent/child relationship tree for a substance.
  • gsrs_browse(): page through the full GSRS substance catalogue.
  • gsrs_vocabularies(): retrieve all controlled vocabulary terms.
  • gsrs_all(): convenience umbrella returning substance metadata, names, codes, structure, and hierarchy in a single named list.
  • write_dataframes_to_excel(): write a named list of data frames to an Excel workbook (requires openxlsx).

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 4.7 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OK2026-08-05
  • NOTE12 OK, 1 NOTE2026-08-01
  • OK13 OK2026-06-09
  • ERROR12 OK, 1 ERROR2026-06-08
  • OK7 OK2026-05-06
Advisories

none known

Documentation

In release 0.1.0
READMEYes · 258 wordsVignettesNoNEWSYes · 67% structured · mentions 0.1.0Citation fileNoWebsiteYes · pkgdown
Help pages
13
Examples that run
0%13 only when donttest examples are enabled (R CMD check --as-cran)
Exported functions with examples
100%
Documented parameters
100%
Return-value docs
100%
Help pages citing references
0%

Downloads

1K
CRAN downloads in the past year
Rank #24,880 · ~3/day · ~84/mo
Daily download trend is not available in this view yet.
12230 days
46090 days
1K1 year
Compare downloads with other packages →
Also on29 r2u3 autocran

Repository

0Stars
0Forks
0Open issues
0Open PRs
1Releases
15Commits
1Commit identities
15 commits · Last activity 2026-05-05
Responsiveness
not measured

Releases over time

2026-05-05 · 12026-07-07 · 1
PracticesBeta

10 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/c1au6i0/rgsrs on 2026-10-25.

Continuous integration (2)
GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Docs source (4)
README.Rmdpkgdown

GitHub Pages site last deployed 2026-05-05 · The repository has a site deploy workflow

pkgdown site last built 2026-05-05

Reproducibility and dev environment (1)
renv
CRAN release process (2)
cran-comments.mdCRAN-SUBMISSION
Show all practicesHide 1 practice
Lint, format, editor (1)
RStudio project
How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies
9 external dependencies (excludes base and recommended)

Installing rgsrs adds 33 packages (21 with compiled code, 21 MB of source tarballs). Heaviest: stringi 11 MB, openssl 1.1 MB, vctrs 1.0 MB.

Depends (1)
R >= 4.1
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect

Nothing depends on this yet.

People & History

People (1)
Author, Maintainer since 0.1.0 (2026)
Releases (1)
  • 0.1.0Latest
    2026-05-05 · current release
  • R
    R 4.6.0 released · 2026-04-24

Package metadata

First published
2026-05-05
Total releases
1 / 1 yrs
License
MIT + file LICENSE OSI
Minimum R
≥ 4.1
Download size
40 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("rgsrs")
Zanettini, C. (2026). rgsrs: Query the FDA Global Substance Registration System (GSRS) API (Version 0.1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.rgsrs

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for rgsrs version 0.1.0 [Data set]. HJJB, LLC. Data release v2026-10-26. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-26, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy