File: xx_ls_wrapper.Rd

package info (click to toggle)
r-cran-pbdzmq 0.3.13%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 856 kB
  • sloc: ansic: 737; sh: 93; pascal: 30; cpp: 6; makefile: 4
file content (41 lines) | stat: -rw-r--r-- 916 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/base_ls.r
\name{ls}
\alias{ls}
\title{A wrapper function for base::ls}
\usage{
ls(
  name,
  pos = -1L,
  envir = as.environment(pos),
  all.names = FALSE,
  pattern,
  sorted = TRUE
)
}
\arguments{
\item{name, pos, envir, all.names, pattern, sorted}{as the original \code{base::ls()}.}
}
\value{
As the original \code{base::ls()} except when \code{all.names} is \code{TRUE}
and \code{envir} is \code{.GlobalEnv}, hidden pbd objects such as
\code{.pbd_env} and \code{.pbdenv} will not be returned.
}
\description{
The \code{ls()} function with modification to avoid listing hidden
pbd objects.
}
\details{
As the original \code{base::ls()}, it returns the names of the objects.
}
\examples{
\dontrun{
library(pbdRPC, quietly = TRUE)
ls(all.names = TRUE)
base::ls(all.names = TRUE)
}

}
\author{
Wei-Chen Chen \email{wccsnow@gmail.com}.
}