R/xcmsExamples.R

In ncGTW: Alignment of LC-MS Profiles by Neighbor-wise Compound-specific Graphical Time Warping with Misalignment Detection

#' Examples of xcmsSet for inputs of ncGTW
#'
#' These two \code{\link[xcms]{xcmsSet-class}} objects are created from the
#' example dataset attached in this package (in extdata folder) with XCMS
#' package. They are examples for inputs of \code{\link{misalignDetect}}.
#'
#' The example dataset contains 20 samples picked from an in-house LC-MS
#' dataset. The user can replicate the two \code{\link[xcms]{xcmsSet-class}}
#' objects with \code{\link[xcms]{xcmsSet}}, \code{\link[xcms]{retcor-methods}},
#' and \code{\link[xcms]{group-methods}}. For details, please refer to the user
#' manual.
#' @docType data
#' @name xcmsExamples
#' @usage data(xcmsExamples)
#' @format A list with two \code{\link[xcms]{xcmsSet-class}} objects and one
#'   \code{ppm} parameter.
NULL