File: add_lib.Rd

package info (click to toggle)
r-cran-pkgmaker 0.32.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,192 kB
  • sloc: sh: 13; makefile: 2
file content (52 lines) | stat: -rw-r--r-- 1,164 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/packages.R
\name{add_lib}
\alias{add_lib}
\title{Adding Package Libraries}
\usage{
add_lib(..., append = FALSE)
}
\arguments{
\item{...}{paths to add to .libPath}

\item{append}{logical that indicates that the paths should be appended
rather than prepended.}
}
\value{
Returns the new set of library paths.
}
\description{
Prepend/append paths to the library path list, using \code{\link{.libPaths}}.
}
\details{
This function is meant to be more convenient than \code{.libPaths}, which requires
more writing if one wants to:
\itemize{
\item sequentially add libraries;
\item append and not prepend new path(s);
\item keep the standard user library in the search path.
}
}
\examples{
ol <- .libPaths()
# called sequentially, .libPaths only add the last library
show( .libPaths('.') )
show( .libPaths(tempdir()) )
# restore
.libPaths(ol)

# .libPaths does not keep the standard user library
show( .libPaths() ) 
show( .libPaths('.') )
# restore
.libPaths(ol)

# with add_lib
show( add_lib('.') )
show( add_lib(tempdir()) )
show( add_lib('..', append=TRUE) )

# restore 
.libPaths(ol)

}