get_phenotypes_dataframe: A dataframe of all/subset of phenotypes in the current...

In wuxi-nextcode/gorr: Genuity Science service API for R

A dataframe of all/subset of phenotypes in the current project.

Description

A dataframe of all/subset of phenotypes in the current project.

Usage

get_phenotypes_dataframe(
  conn,
  pheno_names = list(),
  all_tags = list(),
  any_tags = list(),
  pn_count = NULL,
  categories = list(),
  limit = 100,
  states = list(),
  search = NULL,
  playlist = NULL,
  updated_at = NULL,
  result_types = list(),
  filtered = TRUE
)

Arguments

conn	gor connection structure, create it using platform_connect
pheno_names	Only fetch phenotypes that are in a given list of phenotype names
all_tags	Only fetch phenotypes that have all tags in the given list of tags
any_tags	Fetch phenotypes that have any of the tags in the given list of tags
pn_count	Only list phenotypes that match the given pn counts. (include greater or less symbol in string eg ">10")
categories	Only fetch phenotypes in the given list of categories
limit	Maximum number of results (default: 100)
states	Only fetch phenotypes in the given list of states
search	String of keywords to search for in phenotypes, such as name, categories and tags
playlist	Fetch a specific playlist of phenotypes by the playlist id
updated_at	Only fetch phenotypes that match the given dates. Example: >=2017-04-01 ┃ <=2012-07-04 ┃ 2016-04-30..2016-07-04
result_types	Only fetch phenotypes in the given list of result types
filtered	boolean - Return subset of phenotype info columns. filtered=FALSE returns everything. Default: TRUE

Value

Dataframe of phenotype/s info

Examples

## Not run: 
api_key <- Sys.getenv("GOR_API_KEY")
project <- Sys.getenv("GOR_PROJECT")
conn <- platform_connect(api_key, project)
phenotypes <- get_phenotypes_dataframe(conn, limit=5)

## End(Not run)

wuxi-nextcode/gorr documentation built on Jan. 1, 2023, 7:54 a.m.