File: saveBaseFactor.Rd

package info (click to toggle)
r-bioc-alabaster.base 1.6.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 1,652 kB
  • sloc: cpp: 11,377; sh: 29; makefile: 2
file content (36 lines) | stat: -rw-r--r-- 848 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/saveBaseFactor.R
\name{saveBaseFactor}
\alias{saveBaseFactor}
\alias{saveObject,factor-method}
\alias{stageObject,factor-method}
\title{Save a factor to disk}
\usage{
\S4method{saveObject}{factor}(x, path, ...)
}
\arguments{
\item{x}{A factor.}

\item{path}{String containing the path to a directory in which to save \code{x}.}

\item{...}{Further arguments that are ignored.}
}
\value{
\code{x} is saved inside \code{path}.
\code{NULL} is invisibly returned.
}
\description{
Pretty much as it says, let's save a base R \link{factor} to an on-disk representation.
}
\examples{
tmp <- tempfile()
saveObject(factor(1:10, 1:30), tmp)
list.files(tmp, recursive=TRUE)

}
\seealso{
\code{\link{readBaseFactor}}, to read the files back into the session.
}
\author{
Aaron Lun
}