get_sample_annotation: get annotations for either n samples or selected sampleName

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

Description

get annotations for either n samples or selected sampleName

Usage

get_sample_annotation(
  compendium = "vespucci",
  n = NULL,
  normalization = "limma",
  sampleName = NULL,
  useIds = FALSE
)

Arguments

compendium	A string - the selected compendium
n	A numeric (integer): number of sample to retrieve (default 10)
normalization	A string - 'tpm' (as default), 'limma' or 'legacy'
sampleName	A string - A sampleId or sampleName
useIds	A logical (FALSE as default) - It allows using sampleIds

Value

A data.frame with three columns: sampleId sampleName sampleAnnotation

Examples

## Not run: 
get_sample_annotation(n=5)
get_sample_annotation(sampleName = "U2FtcGxlVHlwZTo2NDE5", useIds = TRUE)
get_sample_annotation(sampleName = "GSM287866.ch1")

## End(Not run)

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