| 883f7f27 |
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/log_transform.R
|
| 8db793ae |
\name{log_transform}
|
| 883f7f27 |
\alias{log_transform}
|
| d0f81a51 |
\title{logarithm transform}
|
| 8db793ae |
\usage{
|
| a110b7e7 |
log_transform(base = 10, ...)
|
| 8db793ae |
}
|
| 56a019fe |
\arguments{
|
| 09388373 |
\item{base}{(numeric) The base of the logarithm used for the transform. The default is \code{10}.\cr}
|
| a110b7e7 |
|
| d0f81a51 |
\item{...}{Additional slots and values passed to \code{struct_class}.}
|
| 56a019fe |
}
|
| 7af536f9 |
\value{
|
| 5d51daa4 |
A \code{log_transform} object with the following \code{output} slots:
\tabular{ll}{
\code{transformed} \tab (DatasetExperiment) A DatasetExperiment object containing the log transformed data. \cr
}
|
| d0f81a51 |
|
| 7af536f9 |
struct object
}
|
| 883f7f27 |
\description{
|
| d0f81a51 |
A logarithmic transform is applied to all values in the data matrix.
|
| 883f7f27 |
}
|
| 09388373 |
\section{Inheritance}{
A \code{log_transform} object inherits the following \code{struct} classes: \cr\cr
|
| 55546c0b |
\verb{[log_transform]} >> \verb{[model]} >> \verb{[struct_class]}
|
| 09388373 |
}
|
| 1a7cd70b |
\examples{
|
| 09388373 |
M = log_transform(
base = 10)
|
| 1a7cd70b |
M = log_transform()
}
|
