Permalink
Browse files

Re-roxygenize

  • Loading branch information...
1 parent bd10eb0 commit 3a9025a76907b68b00a8637970af1c423b2909e6 @wch wch committed Aug 24, 2012
View
@@ -2,7 +2,7 @@
\alias{bash}
\title{Open bash shell in package directory.}
\usage{
- bash(pkg = NULL)
+ bash(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{build}
\title{Build package in specified directory.}
\usage{
- build(pkg = NULL, path = NULL, binary = FALSE)
+ build(pkg = ".", path = NULL, binary = FALSE)
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{build_vignettes}
\title{Build package vignettes.}
\usage{
- build_vignettes(pkg = NULL)
+ build_vignettes(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{build_win}
\title{Build windows binary package.}
\usage{
- build_win(pkg = NULL, version = "R-release")
+ build_win(pkg = ".", version = "R-release")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{check}
\title{Build and check a package, cleaning up automatically on success.}
\usage{
- check(pkg = NULL, document = TRUE, cleanup = TRUE,
+ check(pkg = ".", document = TRUE, cleanup = TRUE,
cran = TRUE, args = NULL)
}
\arguments{
View
@@ -2,7 +2,7 @@
\alias{check_doc}
\title{Check documentation, as \code{R CMD check} does.}
\usage{
- check_doc(pkg = NULL)
+ check_doc(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{clean_dll}
\title{Remove compiled objects from /src/ directory}
\usage{
- clean_dll(pkg)
+ clean_dll(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{clean_vignettes}
\title{Clean built vignettes.}
\usage{
- clean_vignettes(pkg = NULL)
+ clean_vignettes(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{compile_dll}
\title{Compile a .dll/.so from source}
\usage{
- compile_dll(pkg)
+ compile_dll(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{document}
\title{Use roxygen to make documentation.}
\usage{
- document(pkg = NULL, clean = FALSE,
+ document(pkg = ".", clean = FALSE,
roclets = c("collate", "namespace", "rd"),
reload = TRUE)
}
View
@@ -2,7 +2,7 @@
\alias{find_code}
\title{Find all R files in given directory.}
\usage{
- find_code(pkg)
+ find_code(pkg = ".")
}
\description{
Find all R files in given directory.
View
@@ -2,7 +2,7 @@
\alias{imports_env}
\title{Return imports environment for a package}
\usage{
- imports_env(pkg = NULL)
+ imports_env(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{install}
\title{Install a local development package.}
\usage{
- install(pkg = NULL, reload = TRUE, quick = FALSE,
+ install(pkg = ".", reload = TRUE, quick = FALSE,
args = NULL)
}
\arguments{
View
@@ -2,7 +2,7 @@
\alias{load_all}
\title{Load complete package.}
\usage{
- load_all(pkg = NULL, reset = FALSE, recompile = FALSE,
+ load_all(pkg = ".", reset = FALSE, recompile = FALSE,
export_all = TRUE, self = FALSE)
}
\arguments{
View
@@ -2,7 +2,7 @@
\alias{load_code}
\title{Load R code.}
\usage{
- load_code(pkg = NULL)
+ load_code(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{load_data}
\title{Load data.}
\usage{
- load_data(pkg = NULL)
+ load_data(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{load_dll}
\title{Load a compiled DLL}
\usage{
- load_dll(pkg = NULL)
+ load_dll(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{load_imports}
\title{Load all of the imports for a package}
\usage{
- load_imports(pkg = NULL, deps = c("depends", "imports"))
+ load_imports(pkg = ".", deps = c("depends", "imports"))
}
\description{
The imported objects are copied to the imports
View
@@ -2,7 +2,7 @@
\alias{missing_s3}
\title{Find missing s3 exports.}
\usage{
- missing_s3(pkg = NULL)
+ missing_s3(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{ns_env}
\title{Return the namespace environment for a package.}
\usage{
- ns_env(pkg = NULL)
+ ns_env(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{parse_ns_file}
\title{Parses the NAMESPACE file for a package}
\usage{
- parse_ns_file(pkg)
+ parse_ns_file(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{pkg_env}
\title{Return package environment}
\usage{
- pkg_env(pkg = NULL)
+ pkg_env(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{release}
\title{Release package to CRAN.}
\usage{
- release(pkg = NULL, check = TRUE)
+ release(pkg = ".", check = TRUE)
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{reload}
\title{Unload and reload package.}
\usage{
- reload(pkg = NULL)
+ reload(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{reload_devtools}
\title{Reload the devtools package}
\usage{
- reload_devtools(pkg = NULL, ...)
+ reload_devtools(pkg = ".", ...)
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -4,12 +4,12 @@
\alias{revdep_maintainers}
\title{Reverese dependency tools.}
\usage{
- revdep(pkg, dependencies = c("Depends", "Imports"),
+ revdep(pkg = ".", dependencies = c("Depends", "Imports"),
recursive = FALSE)
- revdep_maintainers(pkg)
+ revdep_maintainers(pkg = ".")
- revdep_check(pkg, ...)
+ revdep_check(pkg = ".", ...)
}
\arguments{
\item{pkg}{package name}
View
@@ -2,7 +2,7 @@
\alias{run_examples}
\title{Run all examples in a package.}
\usage{
- run_examples(pkg = NULL, start = NULL, show = TRUE,
+ run_examples(pkg = ".", start = NULL, show = TRUE,
test = FALSE, run = TRUE)
}
\arguments{
View
@@ -2,7 +2,7 @@
\alias{run_onattach}
\title{Run .onAttach if needed}
\usage{
- run_onattach(pkg = NULL)
+ run_onattach(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{run_onload}
\title{Run .onLoad if needed}
\usage{
- run_onload(pkg = NULL)
+ run_onload(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{show_news}
\title{Show package news}
\usage{
- show_news(pkg = NULL, latest = TRUE, ...)
+ show_news(pkg = ".", latest = TRUE, ...)
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{show_rd}
\title{Show an Rd file in a package.}
\usage{
- show_rd(pkg = NULL, file, ...)
+ show_rd(pkg = ".", file, ...)
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{test}
\title{Execute all \pkg{test_that} tests in a package.}
\usage{
- test(pkg = NULL, filter = NULL)
+ test(pkg = ".", filter = NULL)
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{unload}
\title{Unload a package}
\usage{
- unload(pkg = NULL)
+ unload(pkg = ".")
}
\arguments{
\item{pkg}{package description, can be path or package
View
@@ -2,7 +2,7 @@
\alias{wd}
\title{Set working directory.}
\usage{
- wd(pkg = NULL, path = NULL)
+ wd(pkg = ".", path = NULL)
}
\arguments{
\item{pkg}{package description, can be path or package

0 comments on commit 3a9025a

Please sign in to comment.