pgxFilter: Query available filters

In progenetix/pgxRpi: R wrapper for Progenetix

Query available filters

Description

This function retrieves available filters in the Progenetix database via the Beacon v2 API.

Usage

pgxFilter(
  prefix = NULL,
  return_all_prefix = FALSE,
  domain = "http://progenetix.org",
  entry_point = "beacon",
  dataset = NULL
)

Arguments

prefix	A string specifying the prefix of filters, such as 'NCIT'. Default is NULL, which means that all available filters will be returned. When specified, it returns all filters with the specified prefix.
return_all_prefix	A logical value determining whether to return all valid prefixes of filters used in database. If TRUE, the prefix parameter will be ignored. Default is FALSE.
domain	A string specifying the domain of the query data resource. Default is "http://progenetix.org".
entry_point	A string specifying the entry point of the Beacon v2 API. Default is "beacon", resulting in the endpoint being "http://progenetix.org/beacon".
dataset	A string specifying the dataset to query. When the parameter domain is "http://progenetix.org", available options are "progenetix" (by defualt) and "cancercelllines".

Value

Filter terms used in the data resource that you query.

Examples

pgxFilter(prefix = "NCIT")

progenetix/pgxRpi documentation built on Aug. 10, 2024, 7:10 a.m.