R/00_data.R

In VladaMilch/pdProbeRemap: What the package does (short line)

#' Example of an object of class \code{Alignments}
#'
#' Example of an object of class \code{Alignments}, 
#' with slots \code{samGenome} and \code{samTranscriptome}
#' subsetted for the sake of space
#'
#' @format \code{Alignments} class example object
#' @return object of class \code{Alignments}
"Alignments_class_example"

#' Example of an object used for annotation package building
#'
#' Example of an object used for annotation package building, 
#' a lisf with slot
#' \code{object}, that contains information about tha package
#' \code{parsedDataOLD}, that containns annotation, and
#' \code{AnnotationType}, a character string that specifies 
#' the formant of the main original annotation file
#'
#' @format inner annotation object
#' @return seed with example metadata information about the package
"seed_example"

#' Example of an annotation \code{data.frame}
#'
#'Example of a reference genome annotation \code{data.frame}
#'
#' @format Annotation
#' @return  example Annotation \code{data.frame}
"Annotation_example"