File: keep.Rd

package info (click to toggle)
gdata 3.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 964 kB
  • sloc: sh: 27; makefile: 15
file content (41 lines) | stat: -rw-r--r-- 1,207 bytes parent folder | download
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
37
38
39
40
41
\name{keep}
\alias{keep}
\title{Remove All Objects, Except Those Specified}
\description{
  Remove all objects from the user workspace, except those specified.
}
\usage{
keep(\dots, list=character(), all=FALSE, sure=FALSE)
}
\arguments{
  \item{\dots}{objects to be kept, specified one by one, quoted or
    unquoted.}
  \item{list}{character vector of object names to be kept.}
  \item{all}{whether hidden objects (beginning with a \code{.}) should
    be removed, unless explicitly kept.}
  \item{sure}{whether to perform the removal, otherwise return names of
    objects that would be removed.}
}
\details{
  Implemented with safety caps: objects whose name starts with a
  \code{.} are not removed unless \code{all=TRUE}, and an explicit
  \code{sure=TRUE} is required to remove anything.
}
\value{
  A character vector containing object names that are deleted if
  \code{sure=TRUE}.
}
\author{Arni Magnusson}
\seealso{
  \code{keep} is a convenient interface to \code{\link{rm}} for removing
  most objects from the user workspace.
}
\examples{
data(trees, CO2)
keep(trees)
# To remove all objects except trees, run:
# keep(trees, sure=TRUE)
}
\keyword{data}
\keyword{environment}
\keyword{utilities}