The R Project SVN R

Rev

Rev 25852 | Rev 42333 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 25852 Rev 26436
Line 1... Line 1...
1 
\name{getPackageName}
 1 
\name{getPackageName}
2 
\alias{getPackageName}
 2 
\alias{getPackageName}
3 
\alias{setPackageName}
 3 
\alias{setPackageName}
- 
 
 4 
\alias{packageSlot}
- 
 
 5 
\alias{packageSlot<-}
4 
\title{ The name associated with a given package }
 6 
\title{ The name associated with a given package }
5 
\description{
 7 
\description{
6 
  The functions below produce the package associated with a particular
 8 
  The functions below produce the package associated with a particular
7 
  environment or position on the search list, or of the package containing a particular
 9 
  environment or position on the search list, or of the package containing a particular
8 
  function.  They are primarily used to support computations that need
 10 
  function.  They are primarily used to support computations that need
9 
  to differentiate objects on multiple packages.
 11 
  to differentiate objects on multiple packages.
10 
}
 12 
}
11 
\usage{
 13 
\usage{
12 
getPackageName(where = 1)
 14 
getPackageName(where)
- 
 
 15 
 
- 
 
 16 
packageSlot(object)
- 
 
 17 
packageSlot(object) <- value
13 
}
 18 
}
14 
\arguments{
 19 
\arguments{
15 
  \item{where}{ The environment or position on the search list
 20 
  \item{where}{ The environment or position on the search list
16 
      associated with the desired package. }
 21 
      associated with the desired package. }
- 
 
 22 
 
- 
 
 23 
  \item{object}{An object providing a character string name, plus the
- 
 
 24 
 package in which this object is to be found.}
- 
 
 25 
\item{value}{the name of the package.}
17 
 }
 26 
 }
18 
\details{
 27 
\details{
19 
  Package names are normally installed during loading of the package,
 28 
  Package names are normally installed during loading of the package,
20 
  by the \link{INSTALL} script or by the \code{\link{library}}
 29 
  by the \link{INSTALL} script or by the \code{\link{library}}
21 
  function.  (Currently, the name is stored as the object
 30 
  function.  (Currently, the name is stored as the object
22 
  \code{.packageName} but don't trust this for the future.)
 31 
  \code{.packageName} but don't trust this for the future.)
23 
}
 32 
}
24 
\value{
 33 
\value{
25 
  All the functions return the character-string name of the package
 34 
   \code{packageName} return the character-string name of the package
26 
  (without the extraneous \code{"package:"} found in the search list).
 35 
  (without the extraneous \code{"package:"} found in the search list).
- 
 
 36 
 
- 
 
 37 
  \code{packageSlot} returns or sets the package name slot (currently
- 
 
 38 
 an attribute, not a formal slot, but this will likely change).
27 
}
 39 
}
28 
 
 40 
 
29 
\seealso{ \code{\link{search}} }
 41 
\seealso{ \code{\link{search}} }
30 
 
 42 
 
31 
\examples{
 43 
\examples{