diff --git a/R/lefser.R b/R/lefser.R index 46bce54..9ce4af9 100644 --- a/R/lefser.R +++ b/R/lefser.R @@ -227,7 +227,7 @@ filterKruskal <- function(relab, group, p.value) { #' warning will be emitted (default `TRUE`). #' @param \ldots Additional inputs to lower level functions (not used). #' @return -#' The function returns a dataframe with two columns, which are +#' The function returns a `data.frame` with two columns, which are #' names of microorganisms and their LDA scores. #' #' @importFrom stats kruskal.test reorder rnorm diff --git a/man/lefser.Rd b/man/lefser.Rd index 35ab9ad..4015c26 100644 --- a/man/lefser.Rd +++ b/man/lefser.Rd @@ -36,12 +36,12 @@ default "GROUP").} \item{blockCol}{character(1) Optional column name in \code{colData(relab)} indicating the blocks, usually a factor with two levels (e.g., -`c("adult", "senior")`; default NULL).} +\code{c("adult", "senior")}; default NULL).} \item{assay}{The i-th assay matrix in the \code{SummarizedExperiment} ('relab'; default 1).} -\item{trim.names}{If `TRUE` extracts the most specific taxonomic rank of organism.} +\item{trim.names}{If \code{TRUE} extracts the most specific taxonomic rank of organism.} \item{checkAbundances}{\code{logical(1)} Whether to check if the assay data in the \code{relab} input are relative abundances or counts. If counts are found, a @@ -53,7 +53,7 @@ with relative abundances in the assay} \item{\ldots}{Additional inputs to lower level functions (not used).} } \value{ -The function returns a dataframe with two columns, which are +The function returns a \code{data.frame} with two columns, which are names of microorganisms and their LDA scores. } \description{ diff --git a/man/lefserPlot.Rd b/man/lefserPlot.Rd index 869ee75..395d663 100644 --- a/man/lefserPlot.Rd +++ b/man/lefserPlot.Rd @@ -2,25 +2,25 @@ % Please edit documentation in R/lefserPlot.R \name{lefserPlot} \alias{lefserPlot} -\title{Plots results from `lefser` function} +\title{Plots results from \code{lefser} function} \usage{ lefserPlot(df, colors = c("red", "forestgreen"), trim.names = TRUE) } \arguments{ -\item{df}{Data frame produced by `lefser`.} +\item{df}{Data frame produced by \code{lefser}.} \item{colors}{character(2) The two colors corresponding to class 0 and 1, -respectively. Defaults to `c("red", "forestgreen")`.} +respectively. Defaults to \code{c("red", "forestgreen")}.} -\item{trim.names}{If `TRUE` extracts the most specific taxonomic rank of organism.} +\item{trim.names}{If \code{TRUE} extracts the most specific taxonomic rank of organism.} } \value{ -Function returns plot of effect size scores produed by `lefser`. +Function returns plot of effect size scores produed by \code{lefser}. Positive scores represent microorganisms with that are more abundant in class '1'. Negative scores represent microorganisms with that are more abundant in class '0'. } \description{ -`lefserPlot` function displays effect sizes for differentially expressed microorganisms +\code{lefserPlot} function displays effect sizes for differentially expressed microorganisms and whether they are more abundant in '0' or '1' sample group. } \examples{ diff --git a/man/relativeAb.Rd b/man/relativeAb.Rd index 46058d5..8588aed 100644 --- a/man/relativeAb.Rd +++ b/man/relativeAb.Rd @@ -9,7 +9,7 @@ relativeAb(se, assay = 1L) \arguments{ \item{se}{A SummarizedExperiment object with counts} -\item{assay}{The i-th assay matrix in the `SummarizedExperiment` ('expr'; +\item{assay}{The i-th assay matrix in the \code{SummarizedExperiment} ('relab'; default 1).} } \description{