883f7f27 |
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dataset_chart_classes.R
|
8db793ae |
\name{compare_dist}
|
883f7f27 |
\alias{compare_dist}
|
c15c2bae |
\title{Compare distributions}
|
8db793ae |
\usage{
|
9bf15429 |
compare_dist(factor_name, ...)
|
8db793ae |
}
|
c15c2bae |
\arguments{
|
d0f81a51 |
\item{factor_name}{(character) The name of a sample-meta column to use.}
|
9bf15429 |
|
d0f81a51 |
\item{...}{Additional slots and values passed to \code{struct_class}.}
|
c15c2bae |
}
|
7af536f9 |
\value{
|
5d51daa4 |
A \code{
compare_dist
} object. This object has no \code{output} slots.
See \code{\link[struct]{chart_plot}} in the \code{struct} package to plot this chart object.
|
7af536f9 |
}
|
883f7f27 |
\description{
|
d0f81a51 |
Histograms and boxplots computed across samples and features are used to visually compare two datasets e.g. before and after filtering and/or normalisation.
|
883f7f27 |
}
|
09388373 |
\section{Inheritance}{
A \code{compare_dist} object inherits the following \code{struct} classes: \cr\cr
|
55546c0b |
\verb{[compare_dist]} >> \verb{[chart]} >> \verb{[struct_class]}
|
09388373 |
}
|
1a7cd70b |
\examples{
|
09388373 |
M = compare_dist(
factor_name = "V1")
|
40be1b5c |
D1=MTBLS79_DatasetExperiment(filtered=FALSE)
D2=MTBLS79_DatasetExperiment(filtered=TRUE)
|
5b4e4d3e |
C = compare_dist(factor_name='Class')
|
8db793ae |
chart_plot(C,D1,D2)
|
1a7cd70b |
}
|