@description
section is copied verbatim from the API
documentation site and ends with a link to the corresponding API
endpoint documentation.@details
.gtexr_arguments.R
. All functions
therefore use @inheritParams gtexr_arguments
for
documentation.@family
roxygen tag to match categories on API
documentation. This is used to categorise functions on pkgdown site
reference page.@examples
must produce output and
be a single function call without assignment
(e.g. get_news_items()
, not
x <- get_news_items()
). This is used to pre-populate
argument values in the gtexr shiny app with a working example.\dontrun{}
.Note that the Get
Genomic Features endpoint takes a path parameter “featureId”. The
corresponding gtexr argument is prefixed with “.”
(.featureId
).↩︎
Note however that while variantId
is not
flagged as “required” for Get
Linkage Disequilibrium By Variant Data, no default value is provided
in get_linkage_disequilibrium_by_variant_data()
as
providing NULL
or an unrecognised variant ID returns an
empty response.↩︎