File: moveInSearchPath.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (57 lines) | stat: -rw-r--r-- 1,581 bytes parent folder | download | duplicates (4)
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
53
54
55
56
57
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  moveInSearchPath.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{moveInSearchPath}
\alias{moveInSearchPath.default}
\alias{moveInSearchPath}

\title{Moves a environment in the search path to another position}

\description{
 Moves a environment in the search path to another position.
}

\usage{
\method{moveInSearchPath}{default}(from, to, where=c("before", "after"), ...)
}

\arguments{
  \item{from}{An \code{\link[base]{integer}} specifying the position of the environment
    to be moved, or a \code{\link[base]{character}} specifying the name of the environment
    to be moved.}
  \item{to}{The destination position like the \code{from} argument.}
  \item{where}{A \code{\link[base]{character}} string specify where in relation to the
    destination position the environment should be moved.}
  \item{...}{Not used.}
}

\value{
  Returns (invisibly) the name of the environment moved, if it was
  moved, otherwise \code{\link[base]{NULL}}.
}

\details{
  It is not possible to move the first environment in the search path,
  i.e. the so called global environment.
}

\examples{
  # Make package 'utils' come behind 'datasets' in the search path
  moveInSearchPath("package:utils", "package:datasets", where="after")
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link[base]{search}}().
}



\keyword{programming}
\keyword{internal}