The R Project SVN R

Rev

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

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