Permalink
Browse files

Re-document

  • Loading branch information...
1 parent a4cb05c commit e04880bad6ab9ee33782915536e04a73095d7982 @hadley committed Jul 5, 2011
View
@@ -1,20 +1,20 @@
+export(as.package)
export(bash)
+export(build_vignettes)
export(check)
export(dev_mode)
export(document)
export(has_devel)
-export(install)
export(install_github)
+export(install)
+export(is.package)
+export(load_all)
export(load_c)
export(load_code)
export(load_data)
-export(load_all)
-export(show_news)
export(load_deps)
-export(as.package)
-export(is.package)
export(release)
export(reload)
export(run_examples)
+export(show_news)
export(test)
-export(build_vignettes)
View
@@ -1,18 +1,19 @@
\name{as.package}
\alias{as.package}
\title{Coerce input to a package.}
-\usage{as.package(x)}
-
+\usage{
+ as.package(x = NULL)
+}
+\arguments{
+ \item{x}{object to coerce to a package}
+}
\description{
Coerce input to a package.
}
-
\details{
Possibile specifications of package:
\itemize{ \item path \item name (lookup in .Rpackages)
\item package object }
}
-\arguments{
- \item{x}{object to coerce to a package}
-}
+
View
@@ -1,12 +1,14 @@
\name{bash}
\alias{bash}
\title{Open bash shell in package directory.}
-\usage{bash(pkg)}
-
-\description{
- Open bash shell in package directory.
+\usage{
+ bash(pkg = NULL)
}
\arguments{
- \item{pkg}{package description, can be path or package name. See
-\code{\link{as.package}} for more information}
+ \item{pkg}{package description, can be path or package
+ name. See \code{\link{as.package}} for more information}
}
+\description{
+ Open bash shell in package directory.
+}
+
View
@@ -1,15 +1,20 @@
\name{build}
\alias{build}
\title{Build package in specified directory.}
-\usage{build(pkg, path=tempdir())}
-
-\description{
- Build package in specified directory.
+\usage{
+ build(pkg = NULL, path = tempdir())
}
-\value{a string giving the location (including file name) of the built
-package}
\arguments{
- \item{pkg}{package description, can be path or package name. See
-\code{\link{as.package}} for more information}
+ \item{pkg}{package description, can be path or package
+ name. See \code{\link{as.package}} for more information}
+
\item{path}{path in which to produce package}
}
+\value{
+ a string giving the location (including file name) of the
+ built package
+}
+\description{
+ Build package in specified directory.
+}
+
View
@@ -1,14 +1,16 @@
\name{build_vignettes}
\alias{build_vignettes}
\title{Build package vignettes.}
-\usage{build_vignettes(pkg)}
-
+\usage{
+ build_vignettes(pkg = NULL)
+}
+\arguments{
+ \item{pkg}{package description, can be path or package
+ name. See \code{\link{as.package}} for more information}
+}
\description{
Build package vignettes. Sweave and latex package
vignettes.
}
\keyword{programming}
-\arguments{
- \item{pkg}{package description, can be path or package name. See
-\code{\link{as.package}} for more information}
-}
+
View
@@ -1,9 +1,12 @@
\name{changed_files}
\alias{changed_files}
\title{Given vector of paths, return only those paths that have changed since the...}
-
+\usage{
+ changed_files(paths)
+}
\description{
Given vector of paths, return only those paths that have
changed since the last invocation.
}
\keyword{internal}
+
View
@@ -1,23 +1,25 @@
\name{check}
\alias{check}
\title{Build and check a package, cleaning up automatically on success.}
-\usage{check(pkg, document=TRUE)}
+\usage{
+ check(pkg = NULL, document = TRUE)
+}
+\arguments{
+ \item{pkg}{package description, can be path or package
+ name. See \code{\link{as.package}} for more information}
+ \item{document}{if \code{TRUE} (the default), will update
+ and check documentation before running formal check.}
+}
\description{
Build and check a package, cleaning up automatically on
success.
}
-
\details{
\code{check} automatically builds a package before using
\code{R CMD check} as this is the recommended way to
check pakcages. Note that this process runs in an
independent realisation of R, so nothing in your current
workspace will affect the proces.
}
-\arguments{
- \item{pkg}{package description, can be path or package name. See
-\code{\link{as.package}} for more information}
- \item{document}{if \code{TRUE} (the default), will update and check
-documentation before running formal check.}
-}
+
View
@@ -1,8 +1,8 @@
\name{clear_cache}
\alias{clear_cache}
\title{Clear file cache.}
-
\description{
Clear file cache.
}
\keyword{internal}
+
View
@@ -1,9 +1,11 @@
\name{clear_pkg_env}
\alias{clear_pkg_env}
\title{Detach development environment...}
-\usage{clear_pkg_env(pkg)}
-
+\usage{
+ clear_pkg_env(pkg = NULL)
+}
\description{
Detach development environment
}
\keyword{internal}
+
View
@@ -1,24 +1,28 @@
\name{dev_mode}
\alias{dev_mode}
\title{Activate and deactivate development mode.}
-\usage{dev_mode(on, path="~/R-dev")}
+\usage{
+ dev_mode(on = NULL, path = "~/R-dev")
+}
+\arguments{
+ \item{on}{turn dev mode on (\code{TRUE}) or off
+ (\code{FALSE}). If omitted will guess based on whether
+ or not \code{path} is in \code{\link{.libPaths}}}
+ \item{path}{directory to for library.}
+}
\description{
Activate and deactivate development mode.
}
-
\details{
When activated, \code{dev_mode} creates a new library for
storing installed packages. This is automatically removed
when \code{dev_mode} is activated. This allows you to
test development packages in a sandbox, without
interfering with the other packages you have installed.
}
-\arguments{
- \item{on}{turn dev mode on (\code{TRUE}) or off (\code{FALSE}). If omitted
-will guess based on whether or not \code{path} is in
-\code{\link{.libPaths}}}
- \item{path}{directory to for library.}
+\examples{
+dev_mode()
+dev_mode()
}
-\examples{dev_mode()
-dev_mode()}
+
View
@@ -1,15 +1,21 @@
\name{document}
\alias{document}
\title{Use roxygen to make documentation.}
-\usage{document(pkg, check=TRUE)}
+\usage{
+ document(pkg = NULL, clean = FALSE)
+}
+\arguments{
+ \item{pkg}{package description, can be path or package
+ name. See \code{\link{as.package}} for more information}
+ \item{clean}{if \code{TRUE} will automatically clear all
+ roxygen caches and delete currently man contents to
+ ensure that you have the freshest version of the
+ documentation. check documentation after running
+ roxygen.}
+}
\description{
Use roxygen to make documentation.
}
\keyword{programming}
-\arguments{
- \item{pkg}{package description, can be path or package name. See
-\code{\link{as.package}} for more information}
- \item{check}{if \code{TRUE} (the default), will automatically
-check documentation after running roxygen.}
-}
+
View
@@ -1,9 +1,11 @@
\name{env_name}
\alias{env_name}
\title{Generate name of package development environment...}
-\usage{env_name(pkg)}
-
+\usage{
+ env_name(pkg = NULL)
+}
\description{
Generate name of package development environment
}
\keyword{internal}
+
View
@@ -1,9 +1,11 @@
\name{find_code}
\alias{find_code}
\title{Find all R files in given directory.}
-\usage{find_code(path)}
-
+\usage{
+ find_code(path)
+}
\description{
Find all R files in given directory.
}
\keyword{internal}
+
View
@@ -1,14 +1,17 @@
\name{has_devel}
\alias{has_devel}
\title{Check if you have a development environment installed.}
-
+\value{
+ TRUE if your development environment is correctly set up,
+ otherwise returns an error.
+}
\description{
Check if you have a development environment installed.
}
-
\details{
Thanks to the suggestion on Simon Urbanek.
}
-\value{TRUE if your development environment is correctly set up, otherwise
-returns an error.}
-\examples{has_devel()}
+\examples{
+has_devel()
+}
+
View
@@ -1,12 +1,19 @@
\name{install}
\alias{install}
\title{Install a package.}
-\usage{install(pkg, reload=TRUE)}
+\usage{
+ install(pkg = NULL, reload = TRUE)
+}
+\arguments{
+ \item{pkg}{package description, can be path or package
+ name. See \code{\link{as.package}} for more information}
+ \item{reload}{if \code{TRUE} (the default), will
+ automatically reload the package after installing.}
+}
\description{
Install a package.
}
-
\details{
Uses \code{R CMD INSTALL} to install the package. Will
also try to install dependencies of the package from
@@ -16,9 +23,4 @@
produced by \code{R CMD build} to avoid modifying the
local directory in any way.
}
-\arguments{
- \item{pkg}{package description, can be path or package name. See
-\code{\link{as.package}} for more information}
- \item{reload}{if \code{TRUE} (the default), will automatically reload the
-package after installing.}
-}
+
View
@@ -1,16 +1,24 @@
\name{install_github}
\alias{install_github}
\title{Attempts to install a package directly from github.}
-\usage{install_github(repo, username="hadley", branch="master")}
-
-\description{
- Attempts to install a package directly from github.
+\usage{
+ install_github(repo, username = "hadley", branch =
+ "master")
}
\arguments{
\item{username}{Github username}
+
\item{repo}{Repo name}
- \item{branch}{Desired branch - defaults to \code{"master"}}
+
+ \item{branch}{Desired branch - defaults to
+ \code{"master"}}
}
-\examples{\dontrun{
+\description{
+ Attempts to install a package directly from github.
+}
+\examples{
+\dontrun{
install_github("roxygen")
-}}
+}
+}
+
View
@@ -1,9 +1,11 @@
\name{is.package}
\alias{is.package}
\title{Is the object a package?}
-\usage{is.package(x)}
-
+\usage{
+ is.package(x)
+}
\description{
Is the object a package?
}
\keyword{internal}
+
Oops, something went wrong.

0 comments on commit e04880b

Please sign in to comment.