diff --git a/R/check.R b/R/check.R index 41c824cbf..82f914fe4 100644 --- a/R/check.R +++ b/R/check.R @@ -24,7 +24,7 @@ #' \item The standard environment variables set by devtools: #' [r_env_vars()]. Of particular note for package tests is the #' `NOT_CRAN` env var which lets you know that your tests are not -#' running on cran, and hence can take a reasonable amount of time. +#' running on CRAN, and hence can take a reasonable amount of time. #' #' \item Debugging flags for the compiler, set by #' \code{\link{compiler_flags}(FALSE)}. diff --git a/R/github.R b/R/github.R index 23b655358..8988e17f4 100644 --- a/R/github.R +++ b/R/github.R @@ -81,9 +81,9 @@ github_tag <- function(username, repo, ref = "master") { github_GET(file.path("repos", username, repo, "tags", ref)) } -#' Retrieve Github personal access token. +#' Retrieve GitHub personal access token. #' -#' A github personal access token +#' A GitHub personal access token #' Looks in env var `GITHUB_PAT` #' #' @keywords internal diff --git a/R/lint.R b/R/lint.R index 37429d3fe..569fb0cf1 100644 --- a/R/lint.R +++ b/R/lint.R @@ -1,6 +1,6 @@ #' Lint all source files in a package. #' -#' The default lintings correspond to the style guide at +#' The default linters correspond to the style guide at #' , however it is possible to #' override any or all of them using the `linters` parameter. #' @param pkg package description, can be path or package name. See diff --git a/R/release.R b/R/release.R index d0749cbb5..0b0451d18 100644 --- a/R/release.R +++ b/R/release.R @@ -5,7 +5,7 @@ #' The package release process will: #' #' \itemize{ -#' \item Confirm that the package passes `R CMD check` on relevant platoforms +#' \item Confirm that the package passes `R CMD check` on relevant platforms #' \item Confirm that important files are up-to-date #' \item Build the package #' \item Submit the package to CRAN, using comments in "cran-comments.md" diff --git a/R/revdep.R b/R/revdep.R index 99578be4c..4a3c4ac4d 100755 --- a/R/revdep.R +++ b/R/revdep.R @@ -1,10 +1,10 @@ #' Reverse dependency tools. #' -#' Tools to check and notify maintainers of all CRAN and bioconductor +#' Tools to check and notify maintainers of all CRAN and Bioconductor #' packages that depend on the specified package. #' #' The first run in a session will be time-consuming because it must download -#' all package metadata from CRAN and bioconductor. Subsequent runs will +#' all package metadata from CRAN and Bioconductor. Subsequent runs will #' be faster. #' #' @param pkg Package name. This is unlike most devtools packages which @@ -18,7 +18,7 @@ #' @param dependencies A character vector listing the types of dependencies #' to follow. #' @param bioconductor If `TRUE` also look for dependencies amongst -#' bioconductor packages. +#' Bioconductor packages. #' @param recursive If `TRUE` look for full set of recursive dependencies. #' @inheritParams tools::dependsOnPkgs #' @seealso [revdep_check()] to run R CMD check on all reverse diff --git a/R/save-all.R b/R/save-all.R index dd3cc9b75..c6b19ae2a 100644 --- a/R/save-all.R +++ b/R/save-all.R @@ -2,7 +2,7 @@ #' #' Helper function wrapping IDE-specific calls to save all documents in the #' active session. In this form, callers of `save_all()` don't need to -#' execute any IDE-specific code. This function can be extened to include +#' execute any IDE-specific code. This function can be extended to include #' other IDE implementations of their equivalent #' `rstudioapi::documentSaveAll()` methods. #' @return NULL diff --git a/inst/WORDLIST b/inst/WORDLIST new file mode 100644 index 000000000..a86d6bad2 --- /dev/null +++ b/inst/WORDLIST @@ -0,0 +1,53 @@ +amongst +artefacts +behaviour +Bioconductor +cran +CMD +dev +dir +env +ERRORs +forkable +gists +gui +Hadley +http +https +installable +knitr +lexicographically +LinkingTo +linters +lintr +maintainer's +makefiles +md +NOTEs +objs +pkgbuild +rds +readme +README +realisation +revdep +revdepcheck +rhub +rmarkdown +Rmarkdown +Rmd +roclet +roxygen +RStudio +SHA +srcrefs +testthat +tex +un +VignetteEncoding +VignetteEngine +VignetteIndexEntry +WARNINGs +Wickham +xyz +YAML diff --git a/man/check.Rd b/man/check.Rd index 5e92f4108..2e7150f07 100644 --- a/man/check.Rd +++ b/man/check.Rd @@ -102,7 +102,7 @@ with how check works on CRAN. This includes: \item The standard environment variables set by devtools: \code{\link[=r_env_vars]{r_env_vars()}}. Of particular note for package tests is the \code{NOT_CRAN} env var which lets you know that your tests are not -running on cran, and hence can take a reasonable amount of time. +running on CRAN, and hence can take a reasonable amount of time. \item Debugging flags for the compiler, set by \code{\link{compiler_flags}(FALSE)}. diff --git a/man/github_pat.Rd b/man/github_pat.Rd index d50ffc2fb..f406b4e58 100644 --- a/man/github_pat.Rd +++ b/man/github_pat.Rd @@ -2,12 +2,12 @@ % Please edit documentation in R/github.R \name{github_pat} \alias{github_pat} -\title{Retrieve Github personal access token.} +\title{Retrieve GitHub personal access token.} \usage{ github_pat(quiet = TRUE) } \description{ -A github personal access token +A GitHub personal access token Looks in env var \code{GITHUB_PAT} } \keyword{internal} diff --git a/man/lint.Rd b/man/lint.Rd index 6bafe2480..c4bb98011 100644 --- a/man/lint.Rd +++ b/man/lint.Rd @@ -16,7 +16,7 @@ use the previous results.} \item{...}{additional arguments passed to \code{\link[lintr:lint_package]{lintr::lint_package()}}} } \description{ -The default lintings correspond to the style guide at +The default linters correspond to the style guide at \url{http://r-pkgs.had.co.nz/r.html#style}, however it is possible to override any or all of them using the \code{linters} parameter. } diff --git a/man/release.Rd b/man/release.Rd index 91b268755..d577707fa 100644 --- a/man/release.Rd +++ b/man/release.Rd @@ -24,7 +24,7 @@ Run automated and manual tests, then post package to CRAN. The package release process will: \itemize{ -\item Confirm that the package passes \code{R CMD check} on relevant platoforms +\item Confirm that the package passes \code{R CMD check} on relevant platforms \item Confirm that important files are up-to-date \item Build the package \item Submit the package to CRAN, using comments in "cran-comments.md" diff --git a/man/revdep.Rd b/man/revdep.Rd index c3f9c1c4a..6391484fa 100644 --- a/man/revdep.Rd +++ b/man/revdep.Rd @@ -28,15 +28,15 @@ will not appear in returned vector. This is used in or extremely long check times.} \item{bioconductor}{If \code{TRUE} also look for dependencies amongst -bioconductor packages.} +Bioconductor packages.} } \description{ -Tools to check and notify maintainers of all CRAN and bioconductor +Tools to check and notify maintainers of all CRAN and Bioconductor packages that depend on the specified package. } \details{ The first run in a session will be time-consuming because it must download -all package metadata from CRAN and bioconductor. Subsequent runs will +all package metadata from CRAN and Bioconductor. Subsequent runs will be faster. } \examples{ diff --git a/man/save_all.Rd b/man/save_all.Rd index 42f626e7d..cda131cbd 100644 --- a/man/save_all.Rd +++ b/man/save_all.Rd @@ -9,7 +9,7 @@ save_all() \description{ Helper function wrapping IDE-specific calls to save all documents in the active session. In this form, callers of \code{save_all()} don't need to -execute any IDE-specific code. This function can be extened to include +execute any IDE-specific code. This function can be extended to include other IDE implementations of their equivalent \code{rstudioapi::documentSaveAll()} methods. } diff --git a/vignettes/dependencies.Rmd b/vignettes/dependencies.Rmd index e0910c3e1..e01f460fb 100644 --- a/vignettes/dependencies.Rmd +++ b/vignettes/dependencies.Rmd @@ -32,9 +32,9 @@ The `type` is an optional parameter. If the type is missing the default is to install from GitHub. Additional remote dependencies should be separated by commas, just like normal dependencies elsewhere in the `DESCRIPTION` file. -### Github +### GitHub -Because github is the most commonly used unofficial package distribution in R, it's the default: +Because GitHub is the most commonly used unofficial package distribution in R, it's the default: ```yaml Remotes: hadley/testthat @@ -48,7 +48,7 @@ Remotes: hadley/httr@v0.4, hadley/testthat@c67018fa4970 ``` -A type of 'github' can be specified, but is not required +A type of `github` can be specified, but is not required ```yaml Remotes: github::hadley/ggplot2