Skip to contents

Resolves term to a ClinVar UID, then fetches that record. An rsID is the term that works best.

Usage

clinvar_classification(term, ...)

Arguments

term

A search term, usually an rsID or an accession.

...

Passed to biohttp::get_json(), for example throttle.

Value

A biohttp envelope whose data is a one-row tibble. See clinvar_parse_record().

An rsID does not identify an allele

The same caveat as gnomad_frequency(). 7:g.140753336A>T and 7:g.140753336A>C share rs113488022, so a term that is only an rsID can resolve to a record for the other allele. ClinVar returns the first matching UID, and this function returns that record.

The NCBI API key

Set NCBI_API_KEY and both requests carry it, which raises the rate limit from 3 to 10 requests a second. It is passed as a secret_query, so it stays out of the cache key and out of every message. Without one the client works at the lower limit.

Examples

if (FALSE) { # \dontrun{
biohttp::body_or_null(clinvar_classification("rs113488022"))
} # }