R/documentationDirectory.R

In PavlidisLab/gemmaAPI.R: A wrapper for Gemma's restful API

#' Endpoint functions
#'
#' Basic API calls. These functions return mostly unaltered data from a given API endpoint.
#' 
#' \code{\link{setGemmaUser}}: Allows authentication
#' 
#' \code{\link{allDatasets}}: List all datasets
#' 
#' \code{\link{datasetInfo}}: Get information about a specific dataset
#' 
#' \code{\link{allPlatforms}}: List all platforms
#' 
#' \code{\link{platformInfo}}: Get information about a specific platform
#' 
#' \code{\link{geneInfo}}: Get information about genes
#' 
#' \code{\link{allTaxa}}: List all taxa
#' 
#' \code{\link{taxonInfo}}: Get information about a specific taxon
#' 
#' \code{\link{annotationInfo}}: Query for annotations
#' 
#' \code{\link{setGemmaUser}}: Sets gemma username and password for authentication
#' 
#' 
#' @name endpointFunctions
#' 
NULL




#' High Level Functions
#'
#' High level functions that create useful outputs from basic API calls or from their
#' outputs
#' 
#' \code{\link{compileMetadata}}
#' 
#' \code{\link{expressionSubset}}
#' 
#' \code{\link{readExpression}}
#' 
#' @name highLevelFunctions
#' 
NULL