Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Upgrade to roxygen2 4.0.0

  • Loading branch information...
commit d4f17723c14a954b37bb59e731369f69ddba622d 1 parent 8339169
@hadley authored
Showing with 388 additions and 361 deletions.
  1. +1 −0  DESCRIPTION
  2. +2 −0  NAMESPACE
  3. +5 −5 man/add_build_ignore.Rd
  4. +3 −2 man/add_rstudio_project.Rd
  5. +5 −5 man/add_test_infrastructure.Rd
  6. +3 −2 man/add_travis.Rd
  7. +1 −0  man/as.envlist.Rd
  8. +6 −2 man/as.package.Rd
  9. +1 −0  man/bash.Rd
  10. +11 −12 man/build.Rd
  11. +11 −13 man/build_github_devtools.Rd
  12. +8 −10 man/build_vignettes.Rd
  13. +7 −8 man/build_win.Rd
  14. +13 −14 man/check.Rd
  15. +7 −7 man/check_cran.Rd
  16. +2 −2 man/check_dep_version.Rd
  17. +6 −7 man/check_doc.Rd
  18. +1 −0  man/clean_dll.Rd
  19. +3 −3 man/clean_source.Rd
  20. +3 −3 man/clean_vignettes.Rd
  21. +7 −8 man/compile_dll.Rd
  22. +7 −9 man/compiler_flags.Rd
  23. +6 −6 man/cran_env_vars.Rd
  24. +4 −4 man/create.Rd
  25. +4 −5 man/create_description.Rd
  26. +1 −0  man/dev_example.Rd
  27. +3 −2 man/dev_help.Rd
  28. +2 −2 man/dev_meta.Rd
  29. +6 −6 man/dev_mode.Rd
  30. +1 −0  man/dev_packages.Rd
  31. +3 −2 man/devtest.Rd
  32. +1 −0  man/devtools.Rd
  33. +1 −0  man/document.Rd
  34. +1 −0  man/eval_clean.Rd
  35. +9 −10 man/find_rtools.Rd
  36. +1 −0  man/git_path.Rd
  37. +3 −2 man/has_devel.Rd
  38. +1 −0  man/has_tests.Rd
  39. +8 −7 man/imports_env.Rd
  40. +5 −5 man/inst.Rd
  41. +18 −20 man/install.Rd
  42. +7 −6 man/install_bitbucket.Rd
  43. +1 −0  man/install_deps.Rd
  44. +8 −7 man/install_git.Rd
  45. +3 −4 man/install_git_single.Rd
  46. +7 −7 man/install_github.Rd
  47. +7 −7 man/install_gitorious.Rd
  48. +3 −2 man/install_local.Rd
  49. +8 −7 man/install_url.Rd
  50. +9 −9 man/install_version.Rd
  51. +1 −0  man/is.package.Rd
  52. +15 −14 man/load_all.Rd
  53. +3 −3 man/load_code.Rd
  54. +1 −0  man/load_data.Rd
  55. +1 −0  man/load_dll.Rd
  56. +4 −4 man/load_imports.Rd
  57. +1 −0  man/loaded_packages.Rd
  58. +2 −2 man/missing_s3.Rd
  59. +8 −8 man/ns_env.Rd
  60. +2 −1  man/on_path.Rd
  61. +3 −2 man/parenvs.Rd
  62. +3 −2 man/parse_deps.Rd
  63. +1 −0  man/parse_ns_file.Rd
  64. +3 −2 man/path.Rd
  65. +13 −15 man/pkg_env.Rd
  66. +1 −0  man/print.envlist.Rd
  67. +5 −5 man/r_env_vars.Rd
  68. +13 −12 man/release.Rd
  69. +6 −6 man/reload.Rd
  70. +3 −2 man/revdep.Rd
  71. +5 −5 man/run_examples.Rd
  72. +1 −0  man/run_pkg_hook.Rd
  73. +1 −0  man/show_news.Rd
  74. +5 −4 man/source_gist.Rd
  75. +12 −14 man/source_url.Rd
  76. +7 −7 man/test.Rd
  77. +10 −12 man/unload.Rd
  78. +1 −0  man/wd.Rd
  79. +1 −0  man/with_debug.Rd
  80. +12 −9 man/with_something.Rd
View
1  DESCRIPTION
@@ -10,6 +10,7 @@ Authors@R: c(
Description: Collection of package development tools
Depends:
R (>= 2.15)
+Roxygen: list(wrap = FALSE)
Imports:
httr,
RCurl,
View
2  NAMESPACE
@@ -1,3 +1,5 @@
+# Generated by roxygen2 (4.0.0): do not edit by hand
+
S3method("[",envlist)
S3method(print,envlist)
S3method(replay_stop,default)
View
10 man/add_build_ignore.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{add_build_ignore}
\alias{add_build_ignore}
\title{Add a file to \code{.Rbuildignore}}
@@ -18,11 +19,10 @@ add_build_ignore(pkg = ".", file, escape = TRUE)
Nothing, called for its side effect.
}
\description{
-\code{.Rbuildignore} has a regular expression on each line,
-but it's usually easier to work with specific file names.
-By default, will (crudely) turn a filename into a regular
-expression that will only match that path. Repeated entries
-will be silently removed.
+\code{.Rbuildignore} has a regular expression on each line, but it's
+usually easier to work with specific file names. By default, will (crudely)
+turn a filename into a regular expression that will only match that
+path. Repeated entries will be silently removed.
}
\keyword{internal}
View
5 man/add_rstudio_project.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{add_rstudio_project}
\alias{add_rstudio_project}
\title{Add Rstudio project to a package.}
@@ -9,7 +10,7 @@ add_rstudio_project(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-Does not modify \code{.Rbuildignore} as Rstudio will do
-that when opened for the first time.
+Does not modify \code{.Rbuildignore} as Rstudio will do that when
+opened for the first time.
}
View
10 man/add_test_infrastructure.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{add_test_infrastructure}
\alias{add_test_infrastructure}
\title{Add test skeleton.}
@@ -9,10 +10,9 @@ add_test_infrastructure(pkg = ".")
name. See \code{\link{as.package}} for more information.}
}
\description{
-Add testing infrastructure to a package that does not
-already have it. This will create \file{tests/testthat.R},
-\file{tests/testthat/} and add \pkg{testthat} to the
-suggested packages. This is called automatically from
-\code{\link{test}} if needed.
+Add testing infrastructure to a package that does not already have it.
+This will create \file{tests/testthat.R}, \file{tests/testthat/} and
+add \pkg{testthat} to the suggested packages. This is called
+automatically from \code{\link{test}} if needed.
}
View
5 man/add_travis.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{add_travis}
\alias{add_travis}
\title{Add basic travis template to a package}
@@ -9,7 +10,7 @@ add_travis(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-Also adds \code{.travis.yml} to \code{.Rbuildignore} so it
-isn't included in the built package
+Also adds \code{.travis.yml} to \code{.Rbuildignore} so it isn't included
+in the built package
}
View
1  man/as.envlist.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{as.envlist}
\alias{as.envlist}
\title{Convert a list of environments to an \code{envlist} object.}
View
8 man/as.package.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{as.package}
\alias{as.package}
\title{Coerce input to a package.}
@@ -8,8 +9,11 @@ as.package(x = NULL)
\item{x}{object to coerce to a package}
}
\description{
-Possible specifications of package: \itemize{ \item path
-\item package object }
+Possible specifications of package:
+\itemize{
+ \item path
+ \item package object
+}
}
\keyword{internal}
View
1  man/bash.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{bash}
\alias{bash}
\title{Open bash shell in package directory.}
View
23 man/build.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{build}
\alias{build}
\title{Build package.}
@@ -29,20 +30,18 @@ build(pkg = ".", path = NULL, binary = FALSE, vignettes = TRUE,
function.}
}
\value{
-a string giving the location (including file name) of the
-built package
+a string giving the location (including file name) of the built
+ package
}
\description{
-Building converts a package source directory into a single
-bundled file. If \code{binary = FALSE} this creates a
-\code{tar.gz} package that can be installed on any
-platform, provided they have a full development environment
-(although packages without source code can typically be
-install out of the box). If \code{binary = TRUE}, the
-package will have a platform specific extension (e.g.
-\code{.zip} for windows), and will only be installable on
-the current platform, but no development environment is
-needed.
+Building converts a package source directory into a single bundled file.
+If \code{binary = FALSE} this creates a \code{tar.gz} package that can
+be installed on any platform, provided they have a full development
+environment (although packages without source code can typically be
+install out of the box). If \code{binary = TRUE}, the package will have
+a platform specific extension (e.g. \code{.zip} for windows), and will
+only be installable on the current platform, but no development
+environment is needed.
}
\seealso{
Other build functions: \code{\link{build_win}}
View
24 man/build_github_devtools.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{build_github_devtools}
\alias{build_github_devtools}
\title{Build the development version of devtools from GitHub.}
@@ -10,25 +11,22 @@ build_github_devtools(outfile = NULL)
./devtools.zip (Windows).}
}
\value{
-a string giving the location (including file name) of the
-built package
+a string giving the location (including file name) of the built
+ package
}
\description{
-This function is especially useful for Windows users who
-want to upgrade their version of devtools to the
-development version hosted on on GitHub. In Windows, it's
-not possible to upgrade devtools while the package is
-loaded because there is an open DLL, which in Windows can't
-be overwritten. This function allows you to build a binary
-package of the development version of devtools; then you
-can restart R (so that devtools isn't loaded) and install
+This function is especially useful for Windows users who want to upgrade
+their version of devtools to the development version hosted on on GitHub.
+In Windows, it's not possible to upgrade devtools while the package is loaded
+because there is an open DLL, which in Windows can't be overwritten. This
+function allows you to build a binary package of the development version of
+devtools; then you can restart R (so that devtools isn't loaded) and install
the package.
}
\details{
Mac and Linux users don't need this function; they can use
-\code{\link{install_github}} to install devtools directly,
-without going through the separate build-restart-install
-steps.
+\code{\link{install_github}} to install devtools directly, without going
+through the separate build-restart-install steps.
}
\examples{
\dontrun{
View
18 man/build_vignettes.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{build_vignettes}
\alias{build_vignettes}
\title{Build package vignettes.}
@@ -9,20 +10,17 @@ build_vignettes(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-Builds package vignettes using the same algorithm that
-\code{R CMD build} does. This means includes non-Sweave
-vignettes, using make files (if present), and copying over
-extra files. You need to ensure that these files are not
-included in the built package - ideally they should not be
-checked into source, or at least excluded with
-\code{.Rbuildignore}
+Builds package vignettes using the same algorithm that \code{R CMD build}
+does. This means includes non-Sweave vignettes, using make files (if
+present), and copying over extra files. You need to ensure that these
+files are not included in the built package - ideally they should not
+be checked into source, or at least excluded with \code{.Rbuildignore}
}
\seealso{
\code{\link{clean_vignettes}} to remove the pdfs in
-\file{inst/doc} created from vignettes
+ \file{inst/doc} created from vignettes
-\code{\link{clean_vignettes}} to remove build tex/pdf
-files.
+\code{\link{clean_vignettes}} to remove build tex/pdf files.
}
\keyword{programming}
View
15 man/build_win.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{build_win}
\alias{build_win}
\title{Build windows binary package.}
@@ -18,14 +19,12 @@ build_win(pkg = ".", version = "R-release", quiet = FALSE)
function.}
}
\description{
-This function works by bundling source package, and then
-uploading to \url{http://win-builder.r-project.org/}. Once
-building is complete you'll receive a link to the built
-package in the email address listed in the maintainer
-field. It usually takes around 30 minutes. As a side
-effect, win-build also runs \code{R CMD check} on the
-package, so \code{build_win} is also useful to check that
-your package is ok on windows.
+This function works by bundling source package, and then uploading to
+\url{http://win-builder.r-project.org/}. Once building is complete you'll
+receive a link to the built package in the email address listed in the
+maintainer field. It usually takes around 30 minutes. As a side effect,
+win-build also runs \code{R CMD check} on the package, so \code{build_win}
+is also useful to check that your package is ok on windows.
}
\seealso{
Other build functions: \code{\link{build}}
View
27 man/check.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{check}
\alias{check}
\title{Build and check a package, cleaning up automatically on success.}
@@ -47,20 +48,18 @@ check(pkg = ".", document = TRUE,
checked}
}
\description{
-\code{check} automatically builds and checks a source
-package, using all know best practices. Passing \code{R CMD
-check} is essential if you want to submit your package to
-CRAN: you must not have an ERRORs or WARNINGs, and you want
-to ensure that there are as few NOTEs as possible. If you
-are not submitting to CRAN, at least ensure that there are
-no ERRORs: these typically represent serious problems.
+\code{check} automatically builds and checks a source package, using all
+know best practices. Passing \code{R CMD check} is essential if you want to
+submit your package to CRAN: you must not have an ERRORs or WARNINGs, and you
+want to ensure that there are as few NOTEs as possible. If you are not
+submitting to CRAN, at least ensure that there are no ERRORs: these
+typically represent serious problems.
}
\details{
-\code{check} automatically builds a package before using
-\code{R CMD check} as this is the recommended way to check
-packages. Note that this process runs in an independent
-realisation of R, so nothing in your current workspace will
-affect the process.
+\code{check} automatically builds a package before using \code{R CMD check}
+as this is the recommended way to check packages. Note that this process
+runs in an independent realisation of R, so nothing in your current
+workspace will affect the process.
}
\section{Environment variables}{
Devtools does it's best to set up an environment that
@@ -100,7 +99,7 @@ affect the process.
file.
}
\seealso{
-\code{\link{release}} if you want to send the checked
-package to CRAN.
+\code{\link{release}} if you want to send the checked package to
+ CRAN.
}
View
14 man/check_cran.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{check_cran}
\alias{check_cran}
\title{Check a package from CRAN.}
@@ -33,17 +34,16 @@ check_cran(pkgs, libpath = file.path(tempdir(), "R-lib"), srcpath = libpath,
checked}
}
\value{
-invisible \code{TRUE} if successful and no ERRORs or
-WARNINGS,
+invisible \code{TRUE} if successful and no ERRORs or WARNINGS,
}
\description{
-This is useful for automatically checking that dependencies
-of your packages work.
+This is useful for automatically checking that dependencies of your
+packages work.
}
\details{
-This function does not clean up after itself, but does work
-in a session-specific temporary directory, so all files
-will be removed when your current R session ends.
+This function does not clean up after itself, but does work in a
+session-specific temporary directory, so all files will be removed
+when your current R session ends.
}
\examples{
\dontrun{
View
4 man/check_dep_version.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{check_dep_version}
\alias{check_dep_version}
\title{Check that the version of an imported package satisfies the requirements}
@@ -14,8 +15,7 @@ check_dep_version(dep_name, dep_ver = NA, dep_compare = NA)
check the version}
}
\description{
-Check that the version of an imported package satisfies the
-requirements
+Check that the version of an imported package satisfies the requirements
}
\keyword{internal}
View
13 man/check_doc.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{check_doc}
\alias{check_doc}
\title{Check documentation, as \code{R CMD check} does.}
@@ -9,15 +10,13 @@ check_doc(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\value{
-Nothing. This function is called purely for it's side
-effects: if
+Nothing. This function is called purely for it's side effects: if
}
\description{
-This function attempts to run the documentation related
-checks in the same way that \code{R CMD check} does.
-Unfortunately it can't run them all because some tests
-require the package to be loaded, and the way they attempt
-to load the code conflicts with how devtools does it.
+This function attempts to run the documentation related checks in the
+same way that \code{R CMD check} does. Unfortunately it can't run them
+all because some tests require the package to be loaded, and the way
+they attempt to load the code conflicts with how devtools does it.
}
\examples{
\dontrun{
View
1  man/clean_dll.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{clean_dll}
\alias{clean_dll}
\title{Remove compiled objects from /src/ directory}
View
6 man/clean_source.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{clean_source}
\alias{clean_source}
\title{Sources an R file in a clean environment.}
@@ -13,8 +14,7 @@ clean_source(path, quiet = FALSE)
any explicitly printed output will be displayed.}
}
\description{
-Opens up a fresh R environment and sources file, ensuring
-that it works independently of the current working
-environment.
+Opens up a fresh R environment and sources file, ensuring that it works
+independently of the current working environment.
}
View
6 man/clean_vignettes.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{clean_vignettes}
\alias{clean_vignettes}
\title{Clean built vignettes.}
@@ -9,8 +10,7 @@ clean_vignettes(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-This uses a fairly rudimentary algorithm where any files in
-\file{inst/doc} with a name that exists in \file{vignettes}
-are removed.
+This uses a fairly rudimentary algorithm where any files in \file{inst/doc}
+with a name that exists in \file{vignettes} are removed.
}
View
15 man/compile_dll.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{compile_dll}
\alias{compile_dll}
\title{Compile a .dll/.so from source.}
@@ -12,9 +13,8 @@ compile_dll(pkg = ".", quiet = FALSE)
function.}
}
\description{
-\code{compile_dll} performs a fake R CMD install so should
-code that works here should work with a regular install
-(and vice versa).
+\code{compile_dll} performs a fake R CMD install so should code that
+works here should work with a regular install (and vice versa).
}
\details{
During compilation, debug flags are set with
@@ -23,11 +23,10 @@ During compilation, debug flags are set with
Invisibly returns the names of the DLL.
}
\note{
-If this is used to compile code that uses Rcpp, you will
-need to add the following line to your \code{Makevars} file
-so that it knows where to find the Rcpp headers:
-\code{PKG_CPPFLAGS=`$(R_HOME)/bin/Rscript -e
-'Rcpp:::CxxFlags()'`}
+If this is used to compile code that uses Rcpp, you will need to
+ add the following line to your \code{Makevars} file so that it
+ knows where to find the Rcpp headers:
+ \code{PKG_CPPFLAGS=`$(R_HOME)/bin/Rscript -e 'Rcpp:::CxxFlags()'`}
}
\seealso{
\code{\link{clean_dll}} to delete the compiled files.
View
16 man/compiler_flags.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{compiler_flags}
\alias{compiler_flags}
\title{Default compiler flags used by devtools.}
@@ -9,17 +10,14 @@ compiler_flags(debug = FALSE)
flags (Adding \env{PKG_FFLAGS} and \env{PKG_FCFLAGS}}
}
\description{
-These default flags enforce good coding practice by
-ensuring that \env{PKG_CFLAGS} and \env{PKG_CXXFLAGS} are
-set to \code{-Wall -pedantic}. These tests are run by cran
-and are generally considered to be good practice.
+These default flags enforce good coding practice by ensuring that
+\env{PKG_CFLAGS} and \env{PKG_CXXFLAGS} are set to \code{-Wall -pedantic}.
+These tests are run by cran and are generally considered to be good practice.
}
\details{
-By default \code{\link{compile_dll}} is run with
-\code{compiler_flags(TRUE)}, and check with
-\code{compiler_flags(FALSE)}. If you want to avoid the
-possible performance penalty from the debug flags, install
-the package.
+By default \code{\link{compile_dll}} is run with \code{compiler_flags(TRUE)},
+and check with \code{compiler_flags(FALSE)}. If you want to avoid the
+possible performance penalty from the debug flags, install the package.
}
\examples{
compiler_flags()
View
12 man/cran_env_vars.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{cran_env_vars}
\alias{cran_env_vars}
\title{Cran environmental variables.
@@ -12,12 +13,11 @@ cran_env_vars()
a named character vector
}
\description{
-Cran environmental variables. The environment variables
-that are used CRAN when checking packages. These
-environment variables are from the R Internals document.
-The only difference from that document is that here,
-\code{_R_CHECK_CRAN_INCOMING_} is not set to \code{TRUE}
-because it is so slow.
+Cran environmental variables.
+The environment variables that are used CRAN when checking packages.
+These environment variables are from the R Internals document. The only
+difference from that document is that here, \code{_R_CHECK_CRAN_INCOMING_}
+is not set to \code{TRUE} because it is so slow.
}
\keyword{internal}
View
8 man/create.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{create}
\alias{create}
\title{Creates a new package, following all devtools package conventions.}
@@ -19,10 +20,9 @@ create(path, description = getOption("devtools.desc"), check = FALSE,
\code{\link{add_rstudio_project}})}
}
\description{
-Similar to \code{\link{package.skeleton}}, except that it
-only creates the standard devtools directory structures, it
-doesn't try and create source code and data files by
-inspecting the global environment.
+Similar to \code{\link{package.skeleton}}, except that it only creates
+the standard devtools directory structures, it doesn't try and create
+source code and data files by inspecting the global environment.
}
\examples{
\donttest{
View
9 man/create_description.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{create_description}
\alias{create_description}
\title{Create a default DESCRIPTION file for a package.}
@@ -18,10 +19,8 @@ Create a default DESCRIPTION file for a package.
}
\details{
To set the default author and licenses, set \code{options}
-\code{devtools.desc.author} and
-\code{devtools.desc.license}. I use
-\code{options(devtools.desc.author = '"Hadley Wickham
-<h.wickham@gmail.com> [aut,cre]"', devtools.desc.license =
-"GPL-3")}.
+\code{devtools.desc.author} and \code{devtools.desc.license}. I use
+\code{options(devtools.desc.author = '"Hadley Wickham <h.wickham@gmail.com> [aut,cre]"',
+ devtools.desc.license = "GPL-3")}.
}
View
1  man/dev_example.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{dev_example}
\alias{dev_example}
\title{Run a examples for an in-development function.}
View
5 man/dev_help.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{dev_help}
\alias{dev_help}
\title{Read the in-development help for a package loaded with devtools.}
@@ -17,8 +18,8 @@ dev_help(topic, stage = "render", type = getOption("help_type"))
type.}
}
\description{
-Note that this only renders a single documentation file, so
-that links to other files within the package won't work.
+Note that this only renders a single documentation file, so that links
+to other files within the package won't work.
}
\examples{
\dontrun{
View
4 man/dev_meta.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{dev_meta}
\alias{dev_meta}
\title{Return devtools metadata environment}
@@ -8,8 +9,7 @@ dev_meta(name)
\item{name}{The name of a loaded package}
}
\description{
-If the package was not loaded with devtools, returns
-\code{NULL}.
+If the package was not loaded with devtools, returns \code{NULL}.
}
\examples{
dev_meta("stats") # NULL
View
12 man/dev_mode.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{dev_mode}
\alias{dev_mode}
\title{Activate and deactivate development mode.}
@@ -12,12 +13,11 @@ dev_mode(on = NULL, path = getOption("devtools.path"))
\item{path}{directory to library.}
}
\description{
-When activated, \code{dev_mode} creates a new library for
-storing installed packages. This new library is
-automatically created when \code{dev_mode} is activated if
-it does not already exist. This allows you to test
-development packages in a sandbox, without interfering with
-the other packages you have installed.
+When activated, \code{dev_mode} creates a new library for storing installed
+packages. This new library is automatically created when \code{dev_mode} is
+activated if it does not already exist.
+This allows you to test development packages in a sandbox, without
+interfering with the other packages you have installed.
}
\examples{
\donttest{
View
1  man/dev_packages.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{dev_packages}
\alias{dev_packages}
\title{Return a vector of names of packages loaded by devtools}
View
5 man/devtest.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{devtest}
\alias{devtest}
\title{Return the path to one of the packages in the devtools test dir}
@@ -8,8 +9,8 @@ devtest(package)
\item{package}{Name of the test package.}
}
\description{
-Devtools comes with some simple packages for testing. This
-function returns the path to them.
+Devtools comes with some simple packages for testing. This function
+returns the path to them.
}
\examples{
if (has_tests()) {
View
1  man/devtools.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\docType{package}
\name{devtools}
\alias{devtools}
View
1  man/document.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{document}
\alias{document}
\title{Use roxygen to make documentation.}
View
1  man/eval_clean.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{eval_clean}
\alias{eval_clean}
\alias{evalq_clean}
View
19 man/find_rtools.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{find_rtools}
\alias{find_rtools}
\title{Find rtools.}
@@ -9,19 +10,17 @@ find_rtools(debug = FALSE)
information to help in debugging.}
}
\value{
-Either a visible \code{TRUE} if rtools is found, or an
-invisible \code{FALSE} with a diagnostic
-\code{\link{message}}. As a side-effect the internal
-package variable \code{rtools_path} is updated to the paths
-to rtools binaries.
+Either a visible \code{TRUE} if rtools is found, or an invisible
+ \code{FALSE} with a diagnostic \code{\link{message}}.
+ As a side-effect the internal package variable \code{rtools_path} is
+ updated to the paths to rtools binaries.
}
\description{
To build binary packages on windows, Rtools (found at
-\url{http://cran.r-project.org/bin/windows/Rtools/}) needs
-to be on the path. The default installation process does
-not add it, so this script finds it (looking first on the
-path, then in the registry). It also checks that the
-version of rtools matches the version of R.
+\url{http://cran.r-project.org/bin/windows/Rtools/}) needs to be on
+the path. The default installation process does not add it, so this
+script finds it (looking first on the path, then in the registry).
+It also checks that the version of rtools matches the version of R.
}
\section{Acknowledgements}{
This code borrows heavily from RStudio's code for finding
View
1  man/git_path.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{git_path}
\alias{git_path}
\title{Retrieve the current running path of the git binary.}
View
5 man/has_devel.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{has_devel}
\alias{has_devel}
\title{Check if you have a development environment installed.}
@@ -5,8 +6,8 @@
has_devel()
}
\value{
-TRUE if your development environment is correctly set up,
-otherwise returns an error.
+TRUE if your development environment is correctly set up, otherwise
+ returns an error.
}
\description{
Thanks to the suggestion of Simon Urbanek.
View
1  man/has_tests.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{has_tests}
\alias{has_tests}
\title{Was devtools installed with tests?}
View
15 man/imports_env.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{imports_env}
\alias{imports_env}
\title{Return imports environment for a package}
@@ -10,16 +11,16 @@ imports_env(pkg = ".")
information.}
}
\description{
-Contains objects imported from other packages. Is the
-parent of the package namespace environment, and is a child
-of <namespace:base>, which is a child of R_GlobalEnv.
+Contains objects imported from other packages. Is the parent of the
+package namespace environment, and is a child of <namespace:base>,
+which is a child of R_GlobalEnv.
}
\seealso{
-\code{\link{ns_env}} for the namespace environment that all
-the objects (exported and not exported).
+\code{\link{ns_env}} for the namespace environment that
+ all the objects (exported and not exported).
-\code{\link{pkg_env}} for the attached environment that
-contains the exported objects.
+\code{\link{pkg_env}} for the attached environment that contains
+ the exported objects.
}
\keyword{internal}
View
10 man/inst.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{inst}
\alias{inst}
\title{Get the installation path of a package}
@@ -8,13 +9,12 @@ inst(name)
\item{name}{the name of a package.}
}
\description{
-Given the name of a package, this returns a path to the
-installed copy of the package, which can be passed to other
-devtools functions.
+Given the name of a package, this returns a path to the installed
+copy of the package, which can be passed to other devtools functions.
}
\details{
-It searches for the package in \code{\link{.libPaths}()}.
-If multiple dirs are found, it will return the first one.
+It searches for the package in \code{\link{.libPaths}()}. If multiple
+dirs are found, it will return the first one.
}
\examples{
inst("devtools")
View
38 man/install.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install}
\alias{install}
\title{Install a local development package.}
@@ -50,31 +51,28 @@ install(pkg = ".", reload = TRUE, quick = FALSE, local = TRUE,
option \code{"keep.source.pkgs"}.}
}
\description{
-Uses \code{R CMD INSTALL} to install the package. Will also
-try to install dependencies of the package from CRAN, if
-they're not already installed.
+Uses \code{R CMD INSTALL} to install the package. Will also try to install
+dependencies of the package from CRAN, if they're not already installed.
}
\details{
-By default, installation takes place using the current
-package directory. If you have compiled code, this means
-that artefacts of compilation will be created in the
-\code{src/} directory. If you want to avoid this, you can
-use \code{local = FALSE} to first build a package bundle
-and then install it from a temporary directory. This is
-slower, but keeps the source directory pristine.
+By default, installation takes place using the current package directory.
+If you have compiled code, this means that artefacts of compilation will be
+created in the \code{src/} directory. If you want to avoid this, you can
+use \code{local = FALSE} to first build a package bundle and then install
+it from a temporary directory. This is slower, but keeps the source
+directory pristine.
-If the package is loaded, it will be reloaded after
-installation. This is not always completely possible, see
-\code{\link{reload}} for caveats.
+If the package is loaded, it will be reloaded after installation. This is
+not always completely possible, see \code{\link{reload}} for caveats.
}
\seealso{
-\code{\link{with_debug}} to install packages with debugging
-flags set.
+\code{\link{with_debug}} to install packages with debugging flags
+ set.
-Other package installation:
-\code{\link{install_bitbucket}};
-\code{\link{install_github}};
-\code{\link{install_gitorious}}; \code{\link{install_git}};
-\code{\link{install_url}}; \code{\link{install_version}}
+Other package installation: \code{\link{install_bitbucket}};
+ \code{\link{install_github}};
+ \code{\link{install_gitorious}};
+ \code{\link{install_git}}; \code{\link{install_url}};
+ \code{\link{install_version}}
}
View
13 man/install_bitbucket.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_bitbucket}
\alias{install_bitbucket}
\title{Install a package directly from bitbucket}
@@ -26,8 +27,8 @@ install_bitbucket(repo, username, ref = "master", branch = NULL,
\code{\link{install}}.}
}
\description{
-This function is vectorised so you can install multiple
-packages in a single command.
+This function is vectorised so you can install multiple packages in
+a single command.
}
\examples{
\dontrun{
@@ -37,11 +38,11 @@ install_bitbucket(c("testrepo", "testrepo2"))
}
\seealso{
Bitbucket API docs:
-\url{https://confluence.atlassian.com/display/BITBUCKET/Use+the+Bitbucket+REST+APIs}
+ \url{https://confluence.atlassian.com/display/BITBUCKET/Use+the+Bitbucket+REST+APIs}
Other package installation: \code{\link{install_github}};
-\code{\link{install_gitorious}}; \code{\link{install_git}};
-\code{\link{install_url}}; \code{\link{install_version}};
-\code{\link{install}}
+ \code{\link{install_gitorious}};
+ \code{\link{install_git}}; \code{\link{install_url}};
+ \code{\link{install_version}}; \code{\link{install}}
}
View
1  man/install_deps.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_deps}
\alias{install_deps}
\title{Install package dependencies}
View
15 man/install_git.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_git}
\alias{install_git}
\title{Install a package from a git repository}
@@ -29,8 +30,8 @@ install_git(git_url, name = NULL, subdir = NULL, branch = NULL,
default system's git version.}
}
\description{
-This function requires \code{git} to be installed on your
-system in order to be used.
+This function requires \code{git} to be installed on your system in order to
+be used.
}
\details{
It is vectorised so you can install multiple packages with
@@ -43,10 +44,10 @@ install_git("git://github.com/hadley/stringr.git", branch = "stringr-0.2")
}
}
\seealso{
-Other package installation:
-\code{\link{install_bitbucket}};
-\code{\link{install_github}};
-\code{\link{install_gitorious}}; \code{\link{install_url}};
-\code{\link{install_version}}; \code{\link{install}}
+Other package installation: \code{\link{install_bitbucket}};
+ \code{\link{install_github}};
+ \code{\link{install_gitorious}};
+ \code{\link{install_url}}; \code{\link{install_version}};
+ \code{\link{install}}
}
View
7 man/install_git_single.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_git_single}
\alias{install_git_single}
\title{Install a single package from a git repository}
@@ -25,12 +26,10 @@ install_git_single(git_url, name = NULL, subdir = NULL, branch = NULL,
\item{...}{passed on to \code{\link{install}}}
}
\description{
-This function allows you to install a single package from a
-git repository.
+This function allows you to install a single package from a git repository.
}
\details{
-See \code{\link{install_git}} for more information about
-the paraemeters.
+See \code{\link{install_git}} for more information about the paraemeters.
}
\keyword{internal}
View
14 man/install_github.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_github}
\alias{install_github}
\title{Attempts to install a package directly from github.}
@@ -39,8 +40,8 @@ install_github(repo, username = getOption("github.user"), ref = "master",
\code{\link{install}}.}
}
\description{
-This function is vectorised on \code{repo} so you can
-install multiple packages in a single command.
+This function is vectorised on \code{repo} so you can install multiple
+packages in a single command.
}
\examples{
\dontrun{
@@ -56,10 +57,9 @@ install_github("hadley/devtools")
}
}
\seealso{
-Other package installation:
-\code{\link{install_bitbucket}};
-\code{\link{install_gitorious}}; \code{\link{install_git}};
-\code{\link{install_url}}; \code{\link{install_version}};
-\code{\link{install}}
+Other package installation: \code{\link{install_bitbucket}};
+ \code{\link{install_gitorious}};
+ \code{\link{install_git}}; \code{\link{install_url}};
+ \code{\link{install_version}}; \code{\link{install}}
}
View
14 man/install_gitorious.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_gitorious}
\alias{install_gitorious}
\title{Attempts to install a package directly from gitorious.}
@@ -21,8 +22,8 @@ install_gitorious(repo, project = repo, ref = "master", subdir = NULL,
\code{\link{install}}.}
}
\description{
-This function is vectorised so you can install multiple
-packages in a single command.
+This function is vectorised so you can install multiple packages in
+a single command.
}
\examples{
\dontrun{
@@ -30,10 +31,9 @@ install_gitorious("r-mpc-package")
}
}
\seealso{
-Other package installation:
-\code{\link{install_bitbucket}};
-\code{\link{install_github}}; \code{\link{install_git}};
-\code{\link{install_url}}; \code{\link{install_version}};
-\code{\link{install}}
+Other package installation: \code{\link{install_bitbucket}};
+ \code{\link{install_github}}; \code{\link{install_git}};
+ \code{\link{install_url}}; \code{\link{install_version}};
+ \code{\link{install}}
}
View
5 man/install_local.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_local}
\alias{install_local}
\title{Install a package from a local file}
@@ -15,8 +16,8 @@ install_local(path, subdir = NULL, ...)
\code{\link{install}}.}
}
\description{
-This function is vectorised so you can install multiple
-packages in a single command.
+This function is vectorised so you can install multiple packages in
+a single command.
}
\examples{
\dontrun{
View
15 man/install_url.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_url}
\alias{install_url}
\title{Install a package from a url}
@@ -31,14 +32,14 @@ install_url(url, name = NULL, subdir = NULL, config = list(),
\code{\link{install}}.}
}
\description{
-This function is vectorised so you can install multiple
-packages in a single command.
+This function is vectorised so you can install multiple packages in
+a single command.
}
\seealso{
-Other package installation:
-\code{\link{install_bitbucket}};
-\code{\link{install_github}};
-\code{\link{install_gitorious}}; \code{\link{install_git}};
-\code{\link{install_version}}; \code{\link{install}}
+Other package installation: \code{\link{install_bitbucket}};
+ \code{\link{install_github}};
+ \code{\link{install_gitorious}};
+ \code{\link{install_git}}; \code{\link{install_version}};
+ \code{\link{install}}
}
View
18 man/install_version.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{install_version}
\alias{install_version}
\title{Install specified version of a CRAN package.}
@@ -43,19 +44,18 @@ install_version(package, version = NULL, repos = getOption("repos"),
install source packages.) }
}
\description{
-If you are installing an package that contains compiled
-code, you will need to have an R development environment
-installed. You can check if you do by running
-\code{\link{has_devel}}.
+If you are installing an package that contains compiled code, you will
+need to have an R development environment installed. You can check
+if you do by running \code{\link{has_devel}}.
}
\author{
Jeremy Stephens
}
\seealso{
-Other package installation:
-\code{\link{install_bitbucket}};
-\code{\link{install_github}};
-\code{\link{install_gitorious}}; \code{\link{install_git}};
-\code{\link{install_url}}; \code{\link{install}}
+Other package installation: \code{\link{install_bitbucket}};
+ \code{\link{install_github}};
+ \code{\link{install_gitorious}};
+ \code{\link{install_git}}; \code{\link{install_url}};
+ \code{\link{install}}
}
View
1  man/is.package.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{is.package}
\alias{is.package}
\title{Is the object a package?}
View
29 man/load_all.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{load_all}
\alias{load_all}
\title{Load complete package.}
@@ -30,27 +31,27 @@ load_all(pkg = ".", reset = TRUE, recompile = FALSE, export_all = TRUE,
function.}
}
\description{
-\code{load_all} loads a package. It roughly simulates what
-happens when a package is installed and loaded with
-\code{\link{library}}.
+\code{load_all} loads a package. It roughly simulates what happens
+when a package is installed and loaded with \code{\link{library}}.
}
\details{
Currently \code{load_all}:
-\itemize{ \item Loads all data files in \code{data/}. See
-\code{\link{load_data}} for more details.
+\itemize{
+ \item Loads all data files in \code{data/}. See \code{\link{load_data}}
+ for more details.
-\item Sources all R files in the R directory, storing
-results in environment that behaves like a regular package
-namespace. See below and \code{\link{load_code}} for more
-details.
+\item Sources all R files in the R directory, storing results in
+ environment that behaves like a regular package namespace. See
+ below and \code{\link{load_code}} for more details.
-\item Compiles any C, C++, or Fortran code in the
-\code{src/} directory and connects the generated DLL into
-R. See \code{\link{compile_dll}} for more details.
+\item Compiles any C, C++, or Fortran code in the \code{src/} directory
+ and connects the generated DLL into R. See \code{\link{compile_dll}}
+ for more details.
-\item Runs \code{.onAttach()}, \code{.onLoad()} and
-\code{.onUnload()} functions at the correct times. }
+\item Runs \code{.onAttach()}, \code{.onLoad()} and \code{.onUnload()}
+ functions at the correct times.
+}
}
\section{Namespaces}{
The namespace environment \code{<namespace:pkgname>}, is
View
6 man/load_code.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{load_code}
\alias{load_code}
\title{Load R code.}
@@ -9,9 +10,8 @@ load_code(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-Load all R code in the \code{R} directory. The first time
-the code is loaded, \code{.onLoad} will be run if it
-exists.
+Load all R code in the \code{R} directory. The first time the code is
+loaded, \code{.onLoad} will be run if it exists.
}
\keyword{programming}
View
1  man/load_data.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{load_data}
\alias{load_data}
\title{Load data.}
View
1  man/load_dll.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{load_dll}
\alias{load_dll}
\title{Load a compiled DLL}
View
8 man/load_imports.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{load_imports}
\alias{load_imports}
\title{Load all of the imports for a package}
@@ -5,10 +6,9 @@
load_imports(pkg = ".")
}
\description{
-The imported objects are copied to the imports environment,
-and are not visible from R_GlobalEnv. This will
-automatically load (but not attach) the dependency
-packages.
+The imported objects are copied to the imports environment, and are not
+visible from R_GlobalEnv. This will automatically load (but not attach)
+the dependency packages.
}
\keyword{internal}
View
1  man/loaded_packages.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{loaded_packages}
\alias{loaded_packages}
\title{Return a vector of names of attached packages}
View
4 man/missing_s3.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{missing_s3}
\alias{missing_s3}
\title{Find missing s3 exports.}
@@ -9,7 +10,6 @@ missing_s3(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-The method is heuristic - looking for objs with a period in
-their name.
+The method is heuristic - looking for objs with a period in their name.
}
View
16 man/ns_env.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{ns_env}
\alias{ns_env}
\title{Return the namespace environment for a package.}
@@ -9,21 +10,20 @@ ns_env(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-Contains all (exported and non-exported) objects, and is a
-descendent of \code{R_GlobalEnv}. The hieararchy is
-\code{<namespace:pkg>}, \code{<imports:pkg>},
-\code{<namespace:base>}, and then \code{R_GlobalEnv}.
+Contains all (exported and non-exported) objects, and is a descendent of
+\code{R_GlobalEnv}. The hieararchy is \code{<namespace:pkg>},
+\code{<imports:pkg>}, \code{<namespace:base>}, and then
+\code{R_GlobalEnv}.
}
\details{
-If the package is not loaded, this function returns
-\code{NULL}.
+If the package is not loaded, this function returns \code{NULL}.
}
\seealso{
\code{\link{pkg_env}} for the attached environment that
-contains the exported objects.
+ contains the exported objects.
\code{\link{imports_env}} for the environment that contains
-imported objects for the package.
+ imported objects for the package.
}
\keyword{internal}
View
3  man/on_path.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{on_path}
\alias{on_path}
\title{Test if an object is on the path.}
@@ -19,7 +20,7 @@ with_path(tempdir(), on_path("gcc"))
}
\seealso{
Other path: \code{\link{add_path}}, \code{\link{get_path}},
-\code{\link{path}}, \code{\link{set_path}}
+ \code{\link{path}}, \code{\link{set_path}}
}
\keyword{internal}
View
5 man/parenvs.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{parenvs}
\alias{parenvs}
\title{Given an environment or object, return an \code{envlist} of its
@@ -14,8 +15,8 @@ parenvs(e = parent.frame(), all = FALSE)
empty environment (which is the top-level environment).}
}
\description{
-If \code{e} is not specified, it will start with
-environment from which the function was called.
+If \code{e} is not specified, it will start with environment from which
+the function was called.
}
\examples{
# Print the current environment and its parents
View
5 man/parse_deps.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{parse_deps}
\alias{parse_deps}
\title{Parse package dependency strings.}
@@ -10,8 +11,8 @@ parse_deps(string)
}
\value{
list of two character vectors: \code{name} package names,
-and \code{version} package versions. If version is not
-specified, it will be stored as NA.
+ and \code{version} package versions. If version is not specified,
+ it will be stored as NA.
}
\description{
Parse package dependency strings.
View
1  man/parse_ns_file.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{parse_ns_file}
\alias{parse_ns_file}
\title{Parses the NAMESPACE file for a package}
View
5 man/path.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{path}
\alias{add_path}
\alias{get_path}
@@ -32,8 +33,8 @@ set_path(old)
length(get_path())
}
\seealso{
-\code{\link{with_path}} to temporarily set the path for a
-block of code
+\code{\link{with_path}} to temporarily set the path for a block
+ of code
Other path: \code{\link{on_path}}
}
View
28 man/pkg_env.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{pkg_env}
\alias{pkg_env}
\title{Return package environment}
@@ -9,28 +10,25 @@ pkg_env(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-This is an environment like \code{<package:pkg>}. The
-package environment contains the exported objects from a
-package. It is attached, so it is an ancestor of
-\code{R_GlobalEnv}.
+This is an environment like \code{<package:pkg>}. The package
+environment contains the exported objects from a package. It is
+attached, so it is an ancestor of \code{R_GlobalEnv}.
}
\details{
-When a package is loaded the normal way, using
-\code{\link{library}}, this environment contains only the
-exported objects from the namespace. However, when loaded
-with \code{\link{load_all}}, this environment will contain
-all the objects from the namespace, unless \code{load_all}
-is used with \code{export_all=FALSE}.
+When a package is loaded the normal way, using \code{\link{library}},
+this environment contains only the exported objects from the
+namespace. However, when loaded with \code{\link{load_all}}, this
+environment will contain all the objects from the namespace, unless
+\code{load_all} is used with \code{export_all=FALSE}.
-If the package is not attached, this function returns
-\code{NULL}.
+If the package is not attached, this function returns \code{NULL}.
}
\seealso{
-\code{\link{ns_env}} for the namespace environment that all
-the objects (exported and not exported).
+\code{\link{ns_env}} for the namespace environment that
+ all the objects (exported and not exported).
\code{\link{imports_env}} for the environment that contains
-imported objects for the package.
+ imported objects for the package.
}
\keyword{internal}
View
1  man/print.envlist.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{print.envlist}
\alias{print.envlist}
\title{Print an \code{envlist}}
View
10 man/r_env_vars.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{r_env_vars}
\alias{r_env_vars}
\title{Environment variables to set when calling R}
@@ -8,11 +9,10 @@ r_env_vars()
a named character vector
}
\description{
-Devtools sets a number of environmental variables to ensure
-consistent between the current R session and the new
-session, and to ensure that everying behaves the same
-across systems. It also suppresses a common warning on
-windows, and sets \code{NOT_CRAN} so you can tell that your
+Devtools sets a number of environmental variables to ensure consistent
+between the current R session and the new session, and to ensure that
+everying behaves the same across systems. It also suppresses a common
+warning on windows, and sets \code{NOT_CRAN} so you can tell that your
code is not running on CRAN.
}
\keyword{internal}
View
25 man/release.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{release}
\alias{release}
\title{Release package to CRAN.}
@@ -21,20 +22,20 @@ The package release process will:
\itemize{
\item Confirm that the package passes \code{R CMD check}
-\item Ask if you've checked your code on win-builder \item
-Confirm that news is up-to-date \item Confirm that
-DESCRIPTION is ok \item Ask if you've checked packages that
-depend on your package \item Build the package \item Upload
-the package to CRAN \item Draft an email to the CRAN
-maintainer. }
+ \item Ask if you've checked your code on win-builder
+ \item Confirm that news is up-to-date
+ \item Confirm that DESCRIPTION is ok
+ \item Ask if you've checked packages that depend on your package
+ \item Build the package
+ \item Upload the package to CRAN
+ \item Draft an email to the CRAN maintainer.
+}
You also need to read the CRAN repository policy at
-\url{http://cran.r-project.org/web/packages/policies.html}
-and make sure you're in line with the policies.
-\code{release} tries to automate as many of polices as
-possible, but it's impossible to be completely
-comprehensive, and they do change in between releases of
-devtools.
+\url{http://cran.r-project.org/web/packages/policies.html} and make
+sure you're in line with the policies. \code{release} tries to automate as
+many of polices as possible, but it's impossible to be completely
+comprehensive, and they do change in between releases of devtools.
}
\section{Guarantee}{
If a devtools bug causes one of the CRAN maintainers to
View
12 man/reload.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{reload}
\alias{reload}
\title{Unload and reload package.}
@@ -12,12 +13,11 @@ reload(pkg = ".", quiet = FALSE)
function.}
}
\description{
-This attempts to unload and reload a package. If the
-package is not loaded already, it does nothing. It's not
-always possible to cleanly unload a package: see the
-caveats in \code{\link{unload}} for the some of the
-potential failure points. If in doubt, restart R and reload
-the package with \code{\link{library}}.
+This attempts to unload and reload a package. If the package is not loaded
+already, it does nothing. It's not always possible to cleanly unload a
+package: see the caveats in \code{\link{unload}} for the some of the
+potential failure points. If in doubt, restart R and reload the package
+with \code{\link{library}}.
}
\examples{
\dontrun{
View
5 man/revdep.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{revdep}
\alias{revdep}
\alias{revdep_check}
@@ -31,8 +32,8 @@ revdep_check(pkg = NULL, recursive = FALSE, ignore = NULL, ...)
reverse dependencies (and so on) be included?}
}
\description{
-Tools to check and notify maintainers of all all CRAN and
-bioconductor packages that depend on the specified package.
+Tools to check and notify maintainers of all all CRAN and bioconductor
+packages that depend on the specified package.
}
\examples{
\dontrun{
View
10 man/run_examples.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{run_examples}
\alias{run_examples}
\title{Run all examples in a package.}
@@ -34,11 +35,10 @@ run_examples(pkg = ".", start = NULL, show = TRUE, test = FALSE,
work.}
}
\description{
-One of the most frustrating parts of `R CMD check` is
-getting all of your examples to pass - whenever one fails
-you need to fix the problem and then restart the whole
-process. This function makes it a little easier by making
-it possible to run all examples from an R function.
+One of the most frustrating parts of `R CMD check` is getting all of your
+examples to pass - whenever one fails you need to fix the problem and then
+restart the whole process. This function makes it a little easier by
+making it possible to run all examples from an R function.
}
\seealso{
Other example functions: \code{\link{dev_example}}
View
1  man/run_pkg_hook.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{run_pkg_hook}
\alias{run_pkg_hook}
\alias{run_user_hook}
View
1  man/show_news.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{show_news}
\alias{show_news}
\title{Show package news}
View
9 man/source_gist.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{source_gist}
\alias{source_gist}
\title{Run a script on gist}
@@ -22,10 +23,10 @@ source_gist(id, ..., sha1 = NULL, quiet = FALSE)
informative messages.}
}
\description{
-\dQuote{Gist is a simple way to share snippets and pastes
-with others. All gists are git repositories, so they are
-automatically versioned, forkable and usable as a git
-repository.} \url{https://gist.github.com/}
+\dQuote{Gist is a simple way to share snippets and pastes with others.
+ All gists are git repositories, so they are automatically versioned,
+ forkable and usable as a git repository.}
+\url{https://gist.github.com/}
}
\examples{
# You can run gists given their id
View
26 man/source_url.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{source_url}
\alias{source_url}
\title{Run a script through some protocols such as http, https, ftp, etc.}
@@ -15,22 +16,19 @@ source_url(url, ..., sha1 = NULL)
\description{
Internally, \code{source_url} calls \code{\link{getURL}} in
\code{RCurl} package and then read the contents by
-\code{\link{textConnection}}, which is then
-\code{\link{source}}ed. See \code{?getURL} for the
-available protocol.
+\code{\link{textConnection}}, which is then \code{\link{source}}ed.
+See \code{?getURL} for the available protocol.
}
\details{
-If a SHA-1 hash is specified with the \code{sha1} argument,
-then this function will check the SHA-1 hash of the
-downloaded file to make sure it matches the expected value,
-and throw an error if it does not match. If the SHA-1 hash
-is not specified, it will print a message displaying the
-hash of the downloaded file. The purpose of this is to
-improve security when running remotely-hosted code; if you
-have a hash of the file, you can be sure that it has not
-changed. For convenience, it is possible to use a truncated
-SHA1 hash, down to 6 characters, but keep in mind that a
-truncated hash won't be as secure as the full hash.
+If a SHA-1 hash is specified with the \code{sha1} argument, then this
+function will check the SHA-1 hash of the downloaded file to make sure it
+matches the expected value, and throw an error if it does not match. If the
+SHA-1 hash is not specified, it will print a message displaying the hash of
+the downloaded file. The purpose of this is to improve security when running
+remotely-hosted code; if you have a hash of the file, you can be sure that
+it has not changed. For convenience, it is possible to use a truncated SHA1
+hash, down to 6 characters, but keep in mind that a truncated hash won't be
+as secure as the full hash.
}
\examples{
\dontrun{
View
14 man/test.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{test}
\alias{test}
\title{Execute all \pkg{test_that} tests in a package.}
@@ -20,14 +21,13 @@ test(pkg = ".", filter = NULL, fresh = FALSE)
work.}
}
\description{
-Tests are assumed to be located in a \code{inst/tests/}
-directory. See \code{\link[testthat]{test_dir}} for the
-naming convention of test scripts within that directory.
+Tests are assumed to be located in a \code{inst/tests/} directory.
+See \code{\link[testthat]{test_dir}} for the naming convention of test
+scripts within that directory.
}
\details{
-If no testing infrastructure is present, you'll be asked if
-you want devtools to create it for you (in interactive
-sessions only). See \code{\link{add_test_infrastructure}}
-for more details.
+If no testing infrastructure is present, you'll be asked if you want
+devtools to create it for you (in interactive sessions only). See
+\code{\link{add_test_infrastructure}} for more details.
}
View
22 man/unload.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{unload}
\alias{unload}
\title{Unload a package}
@@ -9,18 +10,15 @@ unload(pkg = ".")
name. See \code{\link{as.package}} for more information}
}
\description{
-This function attempts to cleanly unload a package,
-including unloading it's namespace, deleting S4 class
-definitions and unloading any loaded DLLs. Unfortunately S4
-classes are not really designed to be cleanly unloaded, and
-so we have to manually modify the class dependency graph in
-order for it to work - this works on the cases for which we
-have tested but there may be others. Similarly, automated
-DLL unloading is best tested for simple scenarios
-(particularly with \code{useDynLib(pkgname)} and may fail
-in other cases. If you do encounter a failure, please file
-a bug report at
-\url{http://github.com/hadley/devtools/issues}.
+This function attempts to cleanly unload a package, including unloading
+it's namespace, deleting S4 class definitions and unloading any loaded
+DLLs. Unfortunately S4 classes are not really designed to be cleanly
+unloaded, and so we have to manually modify the class dependency graph in
+order for it to work - this works on the cases for which we have tested
+but there may be others. Similarly, automated DLL unloading is best tested
+for simple scenarios (particularly with \code{useDynLib(pkgname)} and may
+fail in other cases. If you do encounter a failure, please file a bug report
+at \url{http://github.com/hadley/devtools/issues}.
}
\examples{
\dontrun{
View
1  man/wd.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{wd}
\alias{wd}
\title{Set working directory.}
View
1  man/with_debug.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{with_debug}
\alias{with_debug}
\title{Temporarily set debugging compilation flags.}
View
21 man/with_something.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
\name{with_something}
\alias{in_dir}
\alias{with_collate}
@@ -47,15 +48,17 @@ with_path(new, code, add = TRUE)
want.}
}
\description{
-\itemize{ \item \code{in_dir}: working directory \item
-\code{with_collate}: collation order \item
-\code{with_envvar}: environmental variables \item
-\code{with_libpaths}: library paths, replacing current
-libpaths \item \code{with_lib}: library paths, prepending
-to current libpaths \item \code{with_locale}: any locale
-setting \item \code{with_options}: options \item
-\code{with_path}: PATH environment variable \item
-\code{with_par}: graphics parameters }
+\itemize{
+ \item \code{in_dir}: working directory
+ \item \code{with_collate}: collation order
+ \item \code{with_envvar}: environmental variables
+ \item \code{with_libpaths}: library paths, replacing current libpaths
+ \item \code{with_lib}: library paths, prepending to current libpaths
+ \item \code{with_locale}: any locale setting
+ \item \code{with_options}: options
+ \item \code{with_path}: PATH environment variable
+ \item \code{with_par}: graphics parameters
+}
}
\section{Deprecation}{
\code{with_env} will be deprecated in devtools 1.2 and
Please sign in to comment.
Something went wrong with that request. Please try again.