man/exportSCEtoFlatFile.Rd
13a65404
 % Generated by roxygen2: do not edit by hand
ba0167f9
 % Please edit documentation in R/exportSCEtoTXT.R
a6e56721
 \name{exportSCEtoFlatFile}
 \alias{exportSCEtoFlatFile}
ba0167f9
 \title{Export a \link[SingleCellExperiment]{SingleCellExperiment} object to flat text files}
13a65404
 \usage{
6357ced6
 exportSCEtoFlatFile(
   sce,
   outputDir = "./",
   overwrite = TRUE,
   gzipped = TRUE,
ef39dc24
   prefix = "SCE"
6357ced6
 )
13a65404
 }
 \arguments{
 \item{sce}{\link[SingleCellExperiment]{SingleCellExperiment} object to be
 exported.}
 
 \item{outputDir}{Name of the directory to store the exported file(s).}
 
 \item{overwrite}{Boolean. Whether to overwrite the output files. Default
a6e56721
 \code{TRUE}.}
13a65404
 
 \item{gzipped}{Boolean. \code{TRUE} if the output files are to be
 gzip compressed. \code{FALSE} otherwise. Default
8d7cbd29
 \code{TRUE}.}
12c7d075
 
ef39dc24
 \item{prefix}{Prefix of file names.}
13a65404
 }
ce30e109
 \value{
 Generates text files containing data from \code{inSCE}.
 }
13a65404
 \description{
ba0167f9
 Writes all assays, colData, rowData, reducedDims, and altExps objects in a
 \link[SingleCellExperiment]{SingleCellExperiment} to text files.
 The items in the 'metadata' slot remain stored in list and are saved in an RDS file.
13a65404
 }
 \examples{
 data(sce_chcl, package = "scds")
c802b90f
 \dontrun{
a6e56721
 exportSCEtoFlatFile(sce_chcl, "sce_chcl")
c802b90f
 }
13a65404
 }