R/data.R

In wmoldham/seahorse: Analyze Seahorse Bioenergetic Data

# data.R

#' Experimental design helpers
#'
#' These objects should help with `Seahorse` object construction.
#'
#' @name helpers
#' @format
#' | **helper** |     **description** |
#' |------------|-----------------------------------|
#' | wells_24   |     a character vector of 24-well plate IDs |
#' | wells_ex   |     example of wells data for `Seahorse` construction |
#' | stages_mst |     list describing the default design of a mitochondrial stress test |
#' @aliases wells_24 stages_mst
NULL

#' @rdname helpers
#' @usage NULL
#' @format NULL
"wells_24"

#' @rdname helpers
#' @usage NULL
#' @format NULL
"wells_ex"

#' @rdname helpers
#' @usage NULL
#' @format NULL
"stages_mst"


#' Seahorse data objects
#'
#' These Seahorse objects enable exploration of the functions within the
#' package.
#'
#' @format
#'
#' | **name** |     **description** |
#' |----------|------------------|
#' | harold   |     The seahorse herald from Disney's *The Little Mermaid* |
#' | horsea   |     A water-type Pokémon that evolves into Seadra |
#' | sheldon  |     The water-allergic seahorse form Pixar's *Finding Nemo* |
#' | storm    |     Aquaman's noble steed
#' | herd     |     A `Herd` object containing the four example data sets |
#'
#' @name examples
#' @aliases harold horsea sheldon storm herd
NULL

#' @format NULL
#' @usage NULL
#' @rdname examples
"harold"

#' @format NULL
#' @usage NULL
#' @rdname examples
"horsea"

#' @format NULL
#' @usage NULL
#' @rdname examples
"sheldon"

#' @format NULL
#' @usage NULL
#' @rdname examples
"storm"