| Line 13... |
Line 13... |
| 13 |
\file{Read-and-delete-me} file describing further steps in packaging.
|
13 |
\file{Read-and-delete-me} file describing further steps in packaging.
|
| 14 |
}
|
14 |
}
|
| 15 |
\usage{
|
15 |
\usage{
|
| 16 |
package.skeleton(name = "anRpackage", list,
|
16 |
package.skeleton(name = "anRpackage", list,
|
| 17 |
environment = .GlobalEnv,
|
17 |
environment = .GlobalEnv,
|
| 18 |
path = ".", force = FALSE, namespace = TRUE,
|
18 |
path = ".", force = FALSE,
|
| 19 |
code_files = character())
|
19 |
code_files = character())
|
| 20 |
}
|
20 |
}
|
| 21 |
\arguments{
|
21 |
\arguments{
|
| 22 |
\item{name}{character string: the package name and directory name for
|
22 |
\item{name}{character string: the package name and directory name for
|
| 23 |
your package.}
|
23 |
your package.}
|
| Line 26... |
Line 26... |
| 26 |
or \code{code_files} will be supplied. See \sQuote{Details}.}
|
26 |
or \code{code_files} will be supplied. See \sQuote{Details}.}
|
| 27 |
\item{environment}{an environment where objects are looked for. See
|
27 |
\item{environment}{an environment where objects are looked for. See
|
| 28 |
\sQuote{Details}.}
|
28 |
\sQuote{Details}.}
|
| 29 |
\item{path}{path to put the package directory in.}
|
29 |
\item{path}{path to put the package directory in.}
|
| 30 |
\item{force}{If \code{FALSE} will not overwrite an existing directory.}
|
30 |
\item{force}{If \code{FALSE} will not overwrite an existing directory.}
|
| 31 |
\item{namespace}{a logical, no longer used, and hence deprecated. A
|
- |
|
| 32 |
\code{NAMESPACE} file is always created to export all objects whose
|
- |
|
| 33 |
names begin with a letter, plus all S4 methods and classes.}
|
- |
|
| 34 |
\item{code_files}{a character vector with the paths to R code files to
|
31 |
\item{code_files}{a character vector with the paths to R code files to
|
| 35 |
build the package around. See \sQuote{Details}.}
|
32 |
build the package around. See \sQuote{Details}.}
|
| 36 |
}
|
33 |
}
|
| 37 |
\value{
|
34 |
\value{
|
| 38 |
Used for its side-effects.
|
35 |
Used for its side-effects.
|
| Line 51... |
Line 48... |
| 51 |
\code{\link{promptClass}}, and \code{\link{promptMethods}} functions.
|
48 |
\code{\link{promptClass}}, and \code{\link{promptMethods}} functions.
|
| 52 |
|
49 |
|
| 53 |
The package sources are placed in subdirectory \code{name} of
|
50 |
The package sources are placed in subdirectory \code{name} of
|
| 54 |
\code{path}. If \code{code_files} is supplied, these files are
|
51 |
\code{path}. If \code{code_files} is supplied, these files are
|
| 55 |
copied; otherwise, objects will be dumped into individual source
|
52 |
copied; otherwise, objects will be dumped into individual source
|
| 56 |
files.
|
- |
|
| 57 |
The file names in \code{code_files} should have suffix \code{".R"} and
|
53 |
files. The file names in \code{code_files} should have suffix
|
| 58 |
be in the current working directory.
|
54 |
\code{".R"} and be in the current working directory.
|
| 59 |
|
55 |
|
| 60 |
The filenames created for source and documentation try to be valid for
|
56 |
The filenames created for source and documentation try to be valid for
|
| 61 |
all OSes known to run R. Invalid characters are replaced by \samp{_},
|
57 |
all OSes known to run \R. Invalid characters are replaced by \samp{_},
|
| 62 |
invalid names are preceded by \samp{zz}, names are converted to lower
|
58 |
invalid names are preceded by \samp{zz}, names are converted to lower
|
| 63 |
case (to avoid case collisions on case-insensitive file systems) and
|
59 |
case (to avoid case collisions on case-insensitive file systems) and
|
| 64 |
finally the converted names are made unique by
|
60 |
finally the converted names are made unique by
|
| 65 |
\code{\link{make.unique}(sep = "_")}. This can be done for code and
|
61 |
\code{\link{make.unique}(sep = "_")}. This can be done for code and
|
| 66 |
help files but not data files (which are looked for by name). Also,
|
62 |
help files but not data files (which are looked for by name). Also,
|
The R Project SVN
R