% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/preprocess.R
\name{diff_expr_get_samp_info}
\alias{diff_expr_get_samp_info}
\title{Function to standardize samp.info sample information data frame}
\usage{
diff_expr_get_samp_info(
  samp.info,
  samples,
  groups,
  ellipse.mapping.groups = NULL
)
}
\arguments{
\item{samp.info}{\code{data.frame}. samp.info object containing information of the project's sample sheet.}

\item{samples}{\code{character}. Name of the column in 'samp.info' containing sample names. If 'samp.info' is not supplied
vector of sample names.}

\item{groups}{\code{character}. Name of the column in 'samp.info' containing grouping information. If 'samp.info' is not supplied
vector of groups.}

\item{ellipse.mapping.groups}{Optional additional grouping for ellipse drawing. Overrides sample groups.
Use for selective highlighting of user-defined sample groups.}
}
\value{
A \code{data.frame} holding the sample sheet standardised to the conventions of this package:
  the sample and grouping columns renamed to \code{SampleNames} and \code{Groups} (and, where
  supplied, the ellipse grouping column to \code{Ellipse}), all coerced to factors with unused levels
  dropped, and the rows ordered by sample name.
}
\description{
Function to standardize samp.info sample information data frame
}
\examples{
si <- diff_expr_get_samp_info(diffwrap_samp_info,
                              samples = "SampleName", groups = "Group")
head(si)
}
