Man pages for maialab/quincunx
REST API Client for the 'PGS' Catalog

ancestry_categoriesAncestry categories and classes
bindBind PGS Catalog objects
clear_cacheClear quincunx cache of memoised functions
cohortsConstructor for the S4 cohorts object.
cohorts-classAn S4 class to represent a set of cohorts
collect_pgs_idsCollect development and evaluation pgs_ids
collect_samplesCollect samples_variants and samples_training
contains_question_markDoes a string contain a question mark?
countExtract the count field from a JSON response
filter_by_idFilter PGS Catalog objects by identifier.
first_non_naReturns the position of the first non-NA value
get_ancestry_categoriesGet ancestry categories and classes
get_ancestry_symbol_mappingsGet PGS Catalog Ancestry Symbol Mappings
get_cohortsGet PGS Catalog Cohorts
get_performance_metricsGet PGS Catalog Performance Metrics
get_publicationsGet PGS Catalog Publications
get_releasesGet PGS Catalog Releases
get_sample_setsGet PGS Catalog Sample Sets
get_scoresGet PGS Catalog Scores
get_trait_categoriesGet PGS Catalog Trait Categories
get_traitsGet PGS Catalog Traits
is_paginatedIs the response paginated?
is_pgs_idIs a string a PGS Catalog identifier?
is_pubmed_idIs a string a PubMed ID?
list_to_s4Convert a named list to an S4 object
msg_400Pretty printing of 404 error
msg_404Pretty printing of 404 error
msg_emptyPretty printing of empty response
nNumber of PGS Catalog entities
no_msgPretty printing of no error message
n_pagesNumber of pages
nr_to_naConvert NR (Not Recorded) to NA (Not Available)
offsetsGenerate offset values
open_in_dbsnpBrowse dbSNP from SNP identifiers.
open_in_pgs_catalogBrowse PGS Catalog entities from the PGS Catalog Web...
open_in_pubmedBrowse PubMed from PubMed identifiers.
performance_metricsConstructor for the S4 performance_metrics object.
performance_metrics-classAn S4 class to represent a set of PGS Catalog Performance...
pgp_to_pgsMap PGP identifiers to PGS identifiers
pgp_to_ppmMap PGP identifiers to PPM identifiers
pgp_to_pssMap PGP identifiers to PSS identifiers
pgs_serverPGS REST API server
pgs_to_pgpMap PGS identifiers to PGP identifiers
pgs_to_ppmMap PGS identifiers to PPM identifiers
pgs_to_pssMap PGS identifiers to PSS identifiers
pgs_to_studyMap PGS identifiers to GWAS study identifiers
pipePipe operator
ppm_to_pgpMap PPM identifiers to PGP identifiers
ppm_to_pgsMap PPM identifiers to PGS identifiers
ppm_to_pssMap PPM identifiers to PSS identifiers
pss_to_pgpMap PSS identifiers to PGP identifiers
pss_to_pgsMap PSS identifiers to PGS identifiers
pss_to_ppmMap PSS identifiers to PPM identifiers
publicationsConstructor for the S4 publications object.
publications-classAn S4 class to represent a set of PGS Catalog Publications
read_scoring_fileRead a polygenic scoring file
releasesConstructor for the S4 releases object.
releases-classAn S4 class to represent a set of PGS Catalog Releases
remap_idRemap identifiers
requestRequest a resource from the PGS REST API
request_allRequest a paginated resource from the PGS REST API
request_warningPretty printing of http error
s4_to_listConvert an S4 object into a list
sample_setsConstructor for the S4 sample_sets object.
sample_sets-classAn S4 class to represent a set of PGS Catalog Sample Sets
scoresConstructor for the S4 scores object.
scores-classAn S4 class to represent a set of PGS Catalog Polygenic...
setopSet operations on PGS Catalog objects
stagesStudy stages
study_to_pgsMap GWAS studies identifiers to PGS identifiers
subset-cohortsSubset a cohorts object
subset-performance_metricsSubset a performance_metrics object
subset-publicationsSubset a publications object
subset-releasesSubset a releases object
subset-sample_setsSubset a sample_sets object
subset-scoresSubset a scores object
subset-trait_categoriesSubset a trait_categories object
subset-traitsSubset a traits object
sureAre you sure?
trait_categoriesConstructor for the S4 trait_categories object.
trait_categories-classAn S4 class to represent a set of PGS Catalog Trait...
traitsConstructor for the S4 traits object.
traits-classAn S4 class to represent a set of PGS Catalog Traits
user_agent_idUser agent identification
write_xlsxExport a PGS Catalog object to xlsx
maialab/quincunx documentation built on Aug. 18, 2022, 5:31 a.m.