Skip to content

bioclients

0.1.1Package record

Clients for Biological Database Web Services

0packages depend
665downloads / year
–test coverage
13/13flavors OK

Overview

About

Look up genes, variants and proteins from R, without writing a client for every biological web service. Each service gets one client that makes the request and returns a table. Parsing is a separate function that needs no network, so it can run on a saved response and be tested offline. Transport, retries, caching and error handling are left to the 'biohttp' package. Dependencies for single services are optional, so you do not install what you will not use. The services covered include 'Ensembl', described in Dyer et al. (2025) doi:10.1093/nar/gkae1071, 'UniProt', in The UniProt Consortium (2025) doi:10.1093/nar/gkae1010, 'gnomAD', in Chen et al. (2024) doi:10.1038/s41586-023-06045-0, 'Open Targets', in Buniello et al. (2025) doi:10.1093/nar/gkae1128, and the 'AlphaFold' Protein Structure Database, in Varadi et al. (2024) doi:10.1093/nar/gkad1011. Each client's help page cites the service it calls.

Changes in 0.1.1

Ensembl VEP

  • Results are matched back on the echoed input line and on vcf_string rather than on a key rebuilt from the reported coordinates. VEP left-trims and renumbers indels, so the rebuilt key matched only SNVs and every indel came back as an empty row.
  • vep_variants() takes an options list of request flags, defaulting to vep_default_options(). dbNSFP is refused.
  • vep_parse_element() adds transcript, gene_id, biotype, hgvsc, hgvsp, canonical, codons, amino_acids, cadd_phred, cadd_raw, revel, the four spliceai_ds_* scores, spliceai_max and lof.
  • New vep_parse_colocated() reads the dbSNP record beside a variant: rsid, gnomAD genome and exome frequencies with their per-population maximum, and the clinical significance of the allele asked. vep_parse_batch() carries these columns.
Show all changes in 0.1.1Hide the rest of the changes in 0.1.1
  • New vep_variants_all() takes any number of variants, chunks them at the 200 VEP accepts per POST and dispatches the chunks through biohttp::post_json_many(). One row per input in input order; a failed chunk becomes rows of NA carrying the envelope status in status.
  • vep_variants_all() puts the input in genome order and sends a repeated variant once, before chunking, rather than once per occurrence. A duplicate now always carries the same answer at every position it was asked at, which was not guaranteed before when duplicates could land in different chunks and see different transient failures. chunk_size and the row count and order the contract promises are unchanged. It also applies a default throttle (one request per second) so an unpaced burst does not trip Ensembl's rate limiter; pass throttle = NULL to disable it.

gnomAD

  • New gnomad_frequency_by_id() looks a variant up by chrom-pos-ref-alt, which names one allele where an rsID names a site, and gnomad_frequencies() does the same for many ids, alias-batched and chunked like gnomad_constraints(). gnomad_variant_id() builds the id. The flat row from gnomad_parse_variant() carries exome and genome af, ac, an and nhomalt, a derived grpmax, faf95 and filters.
  • The 25-alias cost cap was re-verified against the live API for the variant query. The cost is one per alias whatever the selection set.

ClinVar

  • clinvar_classification() throttles by default at the documented E-utilities rate, 3 requests a second or 10 when NCBI_API_KEY is set, and sends tool and email read from BIOHTTP_CALLER_IDENTITY and BIOHTTP_CONTACT_EMAIL when they are set.

MyGene

  • mygene_genes() chunks a list longer than the 1000 identifiers MyGene takes per POST, dispatches the chunks through biohttp::post_json_many() and merges the hits back in input order.

Packaging

Everything below is for the CRAN submission. Nothing here changes how the

package behaves, and no function's arguments or output shape moved.

  • Every example that calls a service now runs under \donttest{} rather than \dontrun{}, 56 of them. \dontrun{} is for an example that genuinely cannot be executed, which none of these are: they are keyless public requests, a client returns an envelope rather than raising, and biohttp's disk cache is off unless a caller turns it on. So an example run with no network prints NULL and writes nothing.
  • Every help page now cites the service behind it. The 29 service files each carry the canonical publication with a DOI and the service's own documentation URL, and the other topics in the file inherit it, so all 134 exported topics have a References section. Each DOI was resolved through CrossRef and checked against the title, author and pagination written here. uniprot_features() carries two, because it calls the EBI Proteins API on a different host to the rest of the file and both are worth naming.
  • The Description field cites five of those references, for Ensembl, UniProt, gnomAD, Open Targets and AlphaFold DB, in the form CRAN asks for.
  • biohttp is on CRAN now, at 0.1.2. So the Remotes: line is gone and we ask for biohttp (>= 0.1.2) instead. I ran the tests against the CRAN build rather than the newer one on GitHub, to be sure nothing here needs a version CRAN cannot give you.
  • cran-comments.md records the submission notes.

From NEWS.md in the release

Install

Health

CRAN checks
13OK
Slowest check: 2.9 min · r-oldrel-windows-x86_64
Status changes
  • OK13 OKNow
  • OK7 OK2026-09-16
Advisories

none known

Documentation

In release 0.1.1
READMEYes · 392 wordsVignettesNoNEWSYes · 100% structured · mentions 0.1.1Citation fileNoWebsiteYes
Help pages
135 (1 internal)includes a package overview page
Examples that run
58%76 run in a plain check · 56 only when donttest examples are enabled (R CMD check --as-cran)
Exported functions with examples
99%
Documented parameters
97%
Return-value docs
100%
Help pages citing references
99%

Downloads

665
CRAN downloads in the past year
Rank #19,857 · ~2/day · ~55/mo
Daily download trend is not available in this view yet.
51030 days
66590 days
6651 year
Compare downloads with other packages →
Also on7 r2u29 autocran

Repository

3Stars
0Forks
1Open issues
0Open PRs
2Releases
171Commits
1Commit identities
api-clientbioinformaticsgene-annotationgenomicshttr2rr-packagevariant-annotation
License file reads as MIT · 171 commits · Last activity 2026-10-08 · +50% stars, 30d
Responsiveness
How these are sampled
PRs merged (all time)
98%
Median days to close, 50 most recently updated closed issues
10
Median days to close, 50 most recently updated closed PRs
0

Stars over time

2026-09-16 · 22026-10-14 · 3
PracticesBeta

14 development-tooling and community-health practices detected across 7 families in the upstream repository

Checks run against github.com/samuelbharti/bioclients on 2026-10-21.

Continuous integration (2)
GitHub ActionsR CMD check workflow

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

Governance and community (3)
Code of conductContributing guideSecurity policy
Docs source (2)

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

Research and citation (1)
CITATION.cff
Show all practicesHide 3 practices
Automation and maintenance (2)
Dependabotpre-commit
Lint, format, editor (3)
lintrLint workflowAir
Git structural (1)
.gitattributes
How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies
8 external dependencies (excludes base and recommended)

Installing bioclients adds 21 packages (14 with compiled code, 7.5 MB of source tarballs). Heaviest: openssl 1.1 MB, jsonlite 1.0 MB, vctrs 1.0 MB.

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

Nothing depends on this yet.

People & History

People (4)
Author, Maintainer since 0.1.1 (2026), Copyright holder
Copyright holder, Funder
Thesis advisor
Thesis advisor
Releases (1)
  • 0.1.1Latest
    2026-09-15 · current release
  • R
    R 4.6.0 released · 2026-04-24

Package metadata

First published
2026-09-15
Total releases
1 / 1 yrs
License
MIT + file LICENSE OSI
Minimum R
≥ 4.0
Download size
260 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("bioclients")
Bharti, S., Posit Software, PBC, Schloerke, B., & Sievert, C. (2026). bioclients: Clients for Biological Database Web Services (Version 0.1.1) [Computer software]. https://doi.org/10.32614/CRAN.package.bioclients

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

The repository also keeps a CITATION.cff.

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 bioclients version 0.1.1 [Data set]. HJJB, LLC. Data release v2026-10-23. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-23, 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