get_biofeature_ranking: get_biofeature_ranking()

In onertipaday/rcompass: R Client for the COMPASS GrapgQL API

Description

get_biofeature_ranking()

Usage

get_biofeature_ranking(
  compendium = "vespucci",
  samplesetNames = NULL,
  normalization = "legacy",
  rank = "uncentered_correlation",
  rankTarget = "biofeatures",
  top_n = 50,
  useIds = TRUE
)

Arguments

compendium	A string - the selected compendium
samplesetNames	A vector of character strings (here sampleset names)
normalization	A string ('legacy' as default)
rank	A string ('magnitude' as default) - use get_ranking
rankTarget	A string ('biofeature' as default)
top_n	A numeric - an integer for selecting the top ranked samplesets
useIds	A logical - TRUE as default

Value

A data.frame with three columns id, name, value

Examples

## Not run: 
my_ss <- c("U2FtcGxlU2V0VHlwZToyMTk4Nw==", "U2FtcGxlU2V0VHlwZToyMTk4OA==",
"U2FtcGxlU2V0VHlwZToyMTk4OQ==", "U2FtcGxlU2V0VHlwZToyMTk5MA==")
get_biofeature_ranking(samplesetNames = my_ss, top_n = 10,
normalization = "tpm", useIds = TRUE)

## End(Not run)

onertipaday/rcompass documentation built on Sept. 18, 2021, 5:13 p.m.