man/reportSeuratNormalization.Rd
95b323db
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/htmlReports.R
0eafe06c
 \name{reportSeuratNormalization}
 \alias{reportSeuratNormalization}
18a0f0e6
 \title{Generates an HTML report for Seurat Normalization
28d6cd18
  and returns the SCE object with the results computed and stored
  inside the object.}
95b323db
 \usage{
0eafe06c
 reportSeuratNormalization(
95b323db
   inSCE,
   outputFile = NULL,
023e6999
   outputPath = NULL,
95b323db
   subtitle = NULL,
   authors = NULL,
28d6cd18
   showSession = FALSE,
   pdf = FALSE,
585c3f51
   forceRun = TRUE
95b323db
 )
 }
 \arguments{
28d6cd18
 \item{inSCE}{Input \code{\link[SingleCellExperiment]{SingleCellExperiment}}
 object previously passed through \code{reportSeuratRun()}.}
95b323db
 
18a0f0e6
 \item{outputFile}{Specify the name of the generated output HTML file.
 If \code{NULL} then the output file name will be based on the name of the
28d6cd18
 Rmarkdown template. Default \code{NULL}.}
95b323db
 
18a0f0e6
 \item{outputPath}{Specify the name of the output directory to save the
 rendered HTML file. If \code{NULL} the file is stored to the current
28d6cd18
 working directory. Default \code{NULL}.}
95b323db
 
18a0f0e6
 \item{subtitle}{A character value specifying the subtitle to use in the
28d6cd18
 report. Default \code{NULL}.}
95b323db
 
18a0f0e6
 \item{authors}{A character value specifying the names of the authors to use
28d6cd18
 in the report. Default \code{NULL}.}
95b323db
 
18a0f0e6
 \item{showSession}{A logical value indicating if session information
28d6cd18
 should be displayed or not. Default is \code{FALSE}.}
95b323db
 
18a0f0e6
 \item{pdf}{A logical value indicating if a pdf should also be generated for
28d6cd18
 each figure in the report. Default is \code{FALSE}.}
9b54f208
 
28d6cd18
 \item{forceRun}{A logical value indicating if all computations previously
 computed should be re-calculated regardless if these computations are
585c3f51
 available in the input object. Default is \code{TRUE}.}
95b323db
 }
 \value{
28d6cd18
 A \code{\link[SingleCellExperiment]{SingleCellExperiment}} object
  with computations stored.
95b323db
 }
 \description{
18a0f0e6
 Generates an HTML report for Seurat Normalization
28d6cd18
  and returns the SCE object with the results computed and stored
  inside the object.
95b323db
 }