Permalink
Browse files

Upgrade to roxygen2 4.0.0

  • Loading branch information...
1 parent 8339169 commit d4f17723c14a954b37bb59e731369f69ddba622d @hadley committed Feb 20, 2014
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
@@ -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
@@ -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
@@ -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}
@@ -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.
}
@@ -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
@@ -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,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
@@ -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,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
@@ -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}}
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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,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
@@ -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.
}
Oops, something went wrong.

0 comments on commit d4f1772

Please sign in to comment.