From 92b9cdaa2015076dcc8b89fd04fbabbc55ad31dd Mon Sep 17 00:00:00 2001 From: Tyler Rinker Date: Thu, 10 Mar 2016 13:08:49 -0500 Subject: [PATCH 1/4] Upped to version 0.4.0 for upcoming CRAN release. * `p_install_version_gh` added as a partner to `p_install_version` for GitHub packages. Thanks to Steve Simpson for this: https://github.com/trinker/pacman/issues/70 close #70 --- DESCRIPTION | 28 +++++++++++++++++++--------- NAMESPACE | 3 ++- NEWS | 5 ++++- NEWS.md | 6 +++++- R/p_install_version_gh.R | 29 +++++++++++++++++++++++++++++ R/p_install_version_single_gh.R | 32 ++++++++++++++++++++++++++++++++ README.md | 2 +- inst/CITATION | 10 +++++----- inst/build.R | 4 ++-- man/p_author.Rd | 2 +- man/p_base.Rd | 10 +++++----- man/p_boot.Rd | 24 ++++++++++++------------ man/p_citation.Rd | 8 ++++---- man/p_cran.Rd | 4 ++-- man/p_data.Rd | 6 +++--- man/p_delete.Rd | 14 +++++++------- man/p_depends.Rd | 20 ++++++++++---------- man/p_detectOS.Rd | 2 +- man/p_exists.Rd | 6 +++--- man/p_extract.Rd | 8 ++++---- man/p_functions.Rd | 6 +++--- man/p_help.Rd | 10 +++++----- man/p_information.Rd | 12 ++++++------ man/p_install.Rd | 8 ++++---- man/p_install_gh.Rd | 6 +++--- man/p_install_version.Rd | 8 ++++---- man/p_install_version_gh.Rd | 27 +++++++++++++++++++++++++++ man/p_interactive.Rd | 4 ++-- man/p_isinstalled.Rd | 2 +- man/p_library.Rd | 8 ++++---- man/p_load.Rd | 22 +++++++++++----------- man/p_load_gh.Rd | 20 ++++++++++---------- man/p_loaded.Rd | 14 +++++++------- man/p_news.Rd | 4 ++-- man/p_old.Rd | 2 +- man/p_opendir.Rd | 2 +- man/p_path.Rd | 4 ++-- man/p_search_any.Rd | 12 ++++++------ man/p_search_library.Rd | 12 ++++++------ man/p_set_cranrepo.Rd | 2 +- man/p_temp.Rd | 2 +- man/p_unload.Rd | 14 +++++++------- man/p_unlock.Rd | 14 +++++++------- man/p_update.Rd | 10 +++++----- man/p_version.Rd | 4 ++-- man/p_vignette.Rd | 16 ++++++++-------- man/print.p_version_diff.Rd | 2 +- man/print.search_any.Rd | 2 +- man/print.wide_table.Rd | 2 +- 49 files changed, 290 insertions(+), 184 deletions(-) create mode 100644 R/p_install_version_gh.R create mode 100644 R/p_install_version_single_gh.R create mode 100644 man/p_install_version_gh.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 1a9a156..cbad63b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: pacman Type: Package Title: Package Management Tool -Version: 0.3.1 +Version: 0.4.0 Date: 2016-03-05 Authors@R: c(person("Tyler", "Rinker", role = c("aut", "cre", "ctb"), email = "tyler.rinker@gmail.com"), person("Dason", @@ -9,18 +9,28 @@ Authors@R: c(person("Tyler", "Rinker", role = c("aut", "cre", "ctb"), "dasonk@iastate.edu"), person("Keith", "Hughitt", role = c("ctb"))) Author: Tyler Rinker [aut, cre, ctb], Dason Kurkiewicz [aut, ctb], - Keith Hughitt [ctb] + Keith Hughitt [ctb] Maintainer: Tyler Rinker -Depends: R (>= 2.13.0) -Imports: devtools, methods, stats, utils -Suggests: knitr, lattice, testthat (>= 0.9.0), XML +Depends: + R (>= 2.13.0) +Imports: + devtools, + methods, + stats, + utils +Suggests: + knitr, + lattice, + testthat (>= 0.9.0), + XML BugReports: https://github.com/trinker/pacman/issues?state=open Description: Tools to more conveniently perform tasks associated with - add-on packages. pacman conveniently wraps library and package - related functions and names them in an intuitive and consistent - fashion. It seeks to combine functionality from lower level - functions which can speed up workflow. + add-on packages. pacman conveniently wraps library and package + related functions and names them in an intuitive and consistent + fashion. It seeks to combine functionality from lower level + functions which can speed up workflow. License: GPL-2 URL: https://github.com/trinker/pacman Roxygen: list(wrap = FALSE) VignetteBuilder: knitr +RoxygenNote: 5.0.1 diff --git a/NAMESPACE b/NAMESPACE index 0d70fd3..ac98514 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,4 +1,4 @@ -# Generated by roxygen2 (4.1.1): do not edit by hand +# Generated by roxygen2: do not edit by hand S3method(print,p_version_diff) S3method(print,search_any) @@ -26,6 +26,7 @@ export(p_information) export(p_install) export(p_install_gh) export(p_install_version) +export(p_install_version_gh) export(p_inter) export(p_interactive) export(p_iscran) diff --git a/NEWS b/NEWS index acbfc6f..cbfc8f7 100644 --- a/NEWS +++ b/NEWS @@ -17,7 +17,7 @@ And constructed with the following guidelines: * Bug fixes and misc changes bumps the patch -CHANGES IN pacman VERSION 0.3.1 - +CHANGES IN pacman VERSION 0.3.1 - 0.4.0 ---------------------------------------------------------------- BUG FIXES @@ -39,6 +39,9 @@ NEW FEATURES * `p_old` added to search for outdated packages. +* `p_install_version_gh` added as a partner to `p_install_version` for GitHub + packages. Thanks to Steve Simpson for this: https://github.com/trinker/pacman/issues/70 + MINOR FEATURES IMPROVEMENTS diff --git a/NEWS.md b/NEWS.md index 9deecc6..caf653b 100644 --- a/NEWS.md +++ b/NEWS.md @@ -17,7 +17,7 @@ And constructed with the following guidelines: * Bug fixes and misc changes bumps the patch -**CHANGES** IN pacman VERSION 0.3.1 - +**CHANGES** IN pacman VERSION 0.3.1 - 0.4.0 ---------------------------------------------------------------- **BUG FIXES** @@ -36,6 +36,10 @@ And constructed with the following guidelines: * `p_version_diff` (`p_ver_diff`) added to determine version difference between a local package and CRAN. + +* `p_install_version_gh` added as a partner to `p_install_version` for GitHub + packages. Thanks to Steve Simpson for this: https://github.com/trinker/pacman/issues/70 + **MINOR FEATURES** diff --git a/R/p_install_version_gh.R b/R/p_install_version_gh.R new file mode 100644 index 0000000..733dd91 --- /dev/null +++ b/R/p_install_version_gh.R @@ -0,0 +1,29 @@ +#' Install Minimal GitHub Package Version +#' +#' Install minimal GitHub package version(s). +#' +#' @param package \code{character} vector of the repository address(es) of the +#' package(s) you want to install a particular minimal version of. Repository +#' address(es) in the format \code{username/repo[/subdir][@@ref|#pull]}. +#' @param version Corresponding \code{character} vector of the minimal +#' package version(s). +#' @keywords version +#' @export +#' @examples +#' p_install_version_gh( +#' c("trinker/pacman", "hadley/testthat"), +#' c("0.2.0", "0.9.1") +#' ) +p_install_version_gh <- function (package, version){ + + ## Check that package and version are equal in length + if (length(package) != length(version)) { + stop("`packages` must be equal in length to `version`") + } + + # Version check on each of the packages + status <- Map(p_install_version_single_gh, package, version) + return(invisible(status)) + +} + diff --git a/R/p_install_version_single_gh.R b/R/p_install_version_single_gh.R new file mode 100644 index 0000000..3df4255 --- /dev/null +++ b/R/p_install_version_single_gh.R @@ -0,0 +1,32 @@ +## Helper single version of p_install_version +p_install_version_single_gh <- function(package, version, ...){ + + ## Determine if package is even in the users library + if (!basename(package) %in% p_lib()){ + out <- p_install_gh(package, ...) + if (isTRUE(out)) { + message(sprintf( + "\n%s not found in user's library; Version %s was installed", + basename(package), utils::packageVersion(basename(package))) + ) + } + return(invisible(out)) + } else { + + ## If package is not in user's library check if version ok + if (p_ver(basename(package)) < version) { + out <- p_install_gh(package, ...) + if (isTRUE(out)) { + message(sprintf("\n%s was updated to v. %s", + basename(package), utils::packageVersion(basename(package)))) + } + return(invisible(out)) + } else { + message(sprintf("\nVersion of %s (v. %s) is suitable", + basename(package), utils::packageVersion(basename(package)))) + return(invisible(TRUE)) + } + } + +} + diff --git a/README.md b/README.md index 0f33ca4..6dfb89d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # pacman -[![Build Status](https://travis-ci.org/trinker/pacman.png?branch=master)](https://travis-ci.org/trinker/pacman) [![DOI](https://zenodo.org/badge/5398/trinker/pacman.svg)](http://dx.doi.org/10.5281/zenodo.15406) [![Version](https://img.shields.io/badge/Version-0.3.0-orange.svg)](https://img.shields.io/badge/Version-0.3.0-orange.svg) +[![Build Status](https://travis-ci.org/trinker/pacman.png?branch=master)](https://travis-ci.org/trinker/pacman) [![DOI](https://zenodo.org/badge/5398/trinker/pacman.svg)](http://dx.doi.org/10.5281/zenodo.15406) [![Version](https://img.shields.io/badge/Version-0.4.0-orange.svg)](https://img.shields.io/badge/Version-0.4.0-orange.svg) The [pacman](http://trinker.github.io/pacman_dev/) package is an R package management tool that combines the functionality of base library related functions into intuitively named functions. This package is ideally added to .Rprofile to increase workflow by reducing time recalling obscurely named functions, reducing code and integrating functionality of base functions to simultaneously perform multiple actions. diff --git a/inst/CITATION b/inst/CITATION index e4228b3..4e74cb1 100644 --- a/inst/CITATION +++ b/inst/CITATION @@ -2,15 +2,15 @@ citHeader("To cite pacman in publications, please use:") citEntry(entry = "manual", - title = "{pacman}: {P}ackage Management for R", + title = "{pacman}: {P}ackage Management for {R}", author = "Tyler W. Rinker and Dason Kurkiewicz", organization = "University at Buffalo/SUNY", address = "Buffalo, New York", - note = "version 0.3.1", - year = "2013", + note = "version 0.4.0", + year = "2015", url = "http://github.com/trinker/pacman", - textVersion = paste("Rinker, T. W. & Kurkiewicz, D. (2013).", + textVersion = paste("Rinker, T. W. & Kurkiewicz, D. (2015).", "pacman: Package Management for R.", - "version 0.3.1. University at Buffalo. Buffalo, New York.", + "version 0.4.0. University at Buffalo. Buffalo, New York.", "http://github.com/trinker/pacman") ) diff --git a/inst/build.R b/inst/build.R index b6cdc97..6b272da 100644 --- a/inst/build.R +++ b/inst/build.R @@ -19,8 +19,8 @@ library(devtools) unlink(paste0(pack, ".pdf"), recursive = TRUE, force = TRUE) x <- file.path(base.git, pack) -document(x) -install(x, quick = quick, build_vignettes = FALSE, dependencies = TRUE) +document('C:/Users/trinker/Desktop/GitHub/pacman') +install('C:/Users/trinker/Desktop/GitHub/pacman', quick = quick, build_vignettes = FALSE, dependencies = TRUE) path <- find.package(pack) system(paste(shQuote(file.path(R.home("bin"), "R")), diff --git a/man/p_author.Rd b/man/p_author.Rd index 9c1f375..bc7b544 100644 --- a/man/p_author.Rd +++ b/man/p_author.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_author.R \name{p_author} \alias{p_author} diff --git a/man/p_base.Rd b/man/p_base.Rd index 0e914da..efa0e72 100644 --- a/man/p_base.Rd +++ b/man/p_base.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_base.R \name{p_base} \alias{p_base} @@ -7,17 +7,17 @@ p_base(base.only = TRUE, open = FALSE, basemarker = "***") } \arguments{ -\item{base.only}{logical. If \code{TRUE} a character vector of only base +\item{base.only}{logical. If \code{TRUE} a character vector of only base install packages is returned.} -\item{open}{logical. If \code{TRUE} opens the directory of the base install +\item{open}{logical. If \code{TRUE} opens the directory of the base install packages.} -\item{basemarker}{Character string. The string to append to mark which +\item{basemarker}{Character string. The string to append to mark which packages are part of the default packages.} } \description{ -List just base packages or list all the packages in the local library and +List just base packages or list all the packages in the local library and mark those in a base install. } \note{ diff --git a/man/p_boot.Rd b/man/p_boot.Rd index 613bc07..4d1b7f3 100644 --- a/man/p_boot.Rd +++ b/man/p_boot.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_boot.R \name{p_boot} \alias{p_boot} @@ -7,10 +7,10 @@ p_boot(load = TRUE, copy2clip = interactive()) } \arguments{ -\item{load}{logical. If \code{TRUE} \code{; library(pacman)} is added to the +\item{load}{logical. If \code{TRUE} \code{; library(pacman)} is added to the end of the script header.} -\item{copy2clip}{logical. If \code{TRUE} attempts to copy the output to the +\item{copy2clip}{logical. If \code{TRUE} attempts to copy the output to the clipboard.} } \value{ @@ -18,21 +18,21 @@ Returns a script header string (optionally copies to the clipboard). } \description{ Generate a string for the standard \pkg{pacman} script header that, when -added to scripts, will ensure \pkg{pacman} is installed before attempting to -use it. \pkg{pacman} will attempt to copy this string (standard script +added to scripts, will ensure \pkg{pacman} is installed before attempting to +use it. \pkg{pacman} will attempt to copy this string (standard script header) to the clipboard for easy cut and paste. } \details{ -The script header takes the form of: +The script header takes the form of: \code{if (!require("pacman")) install.packages("pacman"); library(pacman)} -This can be copied to the top of scripts to make it easy to run scripts if -the user shares them with others or to aid in long term script management. -This may also be useful for blog posts and \pkg{R} help sites like -\href{http://www.talkstats.com/}{TalkStats} or -\href{http://stackoverflow.com/questions/tagged/r}{StackOverflow}. In this -way functions like \code{p_load} can be used without fear that others don't +This can be copied to the top of scripts to make it easy to run scripts if +the user shares them with others or to aid in long term script management. +This may also be useful for blog posts and \pkg{R} help sites like +\href{http://www.talkstats.com/}{TalkStats} or +\href{http://stackoverflow.com/questions/tagged/r}{StackOverflow}. In this +way functions like \code{p_load} can be used without fear that others don't have \pkg{pacman} installed. } \examples{ diff --git a/man/p_citation.Rd b/man/p_citation.Rd index d616fc5..d76fc51 100644 --- a/man/p_citation.Rd +++ b/man/p_citation.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_citation.R \name{p_citation} \alias{p_citation} @@ -14,12 +14,12 @@ p_cite(package = "r", copy2clip = interactive(), \arguments{ \item{package}{Name of the package you want a citation for.} -\item{copy2clip}{logical. If \code{TRUE} attempts to copy the output to the +\item{copy2clip}{logical. If \code{TRUE} attempts to copy the output to the clipboard.} \item{tex}{logical. If \code{TRUE} A only the BibTex version of the citation -is copied to the clipboard. If \code{FALSE} The standard citation is copied -to the clipboard. If \code{NA} both are copied to the clipboard. Default +is copied to the clipboard. If \code{FALSE} The standard citation is copied +to the clipboard. If \code{NA} both are copied to the clipboard. Default allows the user to set a \code{"pac_tex"} in his/her .Rprofile.} \item{\ldots}{Additional inputs to \code{\link[utils]{citation}}} diff --git a/man/p_cran.Rd b/man/p_cran.Rd index 78edc6f..6a87fac 100644 --- a/man/p_cran.Rd +++ b/man/p_cran.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_cran.R \name{p_cran} \alias{p_cran} @@ -10,7 +10,7 @@ p_cran(menu = FALSE) p_iscran(package) } \arguments{ -\item{menu}{logical. If \code{TRUE} allows user to select the package and +\item{menu}{logical. If \code{TRUE} allows user to select the package and return that package name.} \item{package}{Name of package.} diff --git a/man/p_data.Rd b/man/p_data.Rd index ae99e50..66ddacc 100644 --- a/man/p_data.Rd +++ b/man/p_data.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_data.R \name{p_data} \alias{p_data} @@ -7,10 +7,10 @@ p_data(package = "datasets", static = FALSE) } \arguments{ -\item{package}{name of package (default is the base install datasets +\item{package}{name of package (default is the base install datasets package).} -\item{static}{logical. If \code{TRUE} a static text document is returned +\item{static}{logical. If \code{TRUE} a static text document is returned (e.g. \code{data("datasets")}).} } \value{ diff --git a/man/p_delete.Rd b/man/p_delete.Rd index 0f0cdbc..04ca19f 100644 --- a/man/p_delete.Rd +++ b/man/p_delete.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_delete.R \name{p_delete} \alias{p_del} @@ -11,15 +11,15 @@ p_del(..., char, character.only = FALSE, quiet = FALSE) } \arguments{ \item{char}{Character vector containing packages to load. If you are calling -\code{p_delete} from within a function (or just having difficulties calling it -using a character vector input) then pass your character vector of packages +\code{p_delete} from within a function (or just having difficulties calling it +using a character vector input) then pass your character vector of packages to load to this parameter directly.} -\item{character.only}{logical. If \code{TRUE} then \code{p_load} will only -accept a single input which is a character vector containing the names of +\item{character.only}{logical. If \code{TRUE} then \code{p_load} will only +accept a single input which is a character vector containing the names of packages to load.} -\item{quiet}{logical. Passed to \code{print.p_delete} as an attribute. If +\item{quiet}{logical. Passed to \code{print.p_delete} as an attribute. If \code{TRUE} no messages confirming package deletions are printed.} \item{\ldots}{name(s) of package(s).} @@ -29,7 +29,7 @@ Remove package(s) from the library permanently. } \section{Warning}{ -Using this function will remove the package from your +Using this function will remove the package from your library and cannot be loaded again without reinstalling the package. } \examples{ diff --git a/man/p_depends.Rd b/man/p_depends.Rd index d0bdfe2..fd87e3c 100644 --- a/man/p_depends.Rd +++ b/man/p_depends.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_depends.R \name{p_depends} \alias{p_depends} @@ -10,28 +10,28 @@ p_depends(package, local = FALSE, character.only = FALSE, ...) p_depends_reverse(package, local = FALSE, character.only = FALSE, ...) } \arguments{ -\item{package}{Name of the package you want the list of dependencies/reverse +\item{package}{Name of the package you want the list of dependencies/reverse dependencies for.} -\item{local}{logical. If \code{TRUE} checks user's local library for -existence; if \code{FALSE} \href{http://cran.r-project.org/}{CRAN} for the +\item{local}{logical. If \code{TRUE} checks user's local library for +existence; if \code{FALSE} \href{http://cran.r-project.org/}{CRAN} for the package.} -\item{character.only}{logical. If \code{TRUE} the input is a variable +\item{character.only}{logical. If \code{TRUE} the input is a variable containing the package name.} -\item{\ldots}{other arguments passed to -\code{\link[tools]{package_dependencies}} and +\item{\ldots}{other arguments passed to +\code{\link[tools]{package_dependencies}} and \code{\link[tools]{dependsOnPkgs}}.} } \value{ Returns a list of dependencies/reverse dependencies. } \description{ -\code{p_depends} - Get \href{http://cran.r-project.org/}{CRAN} or local +\code{p_depends} - Get \href{http://cran.r-project.org/}{CRAN} or local package dependencies. -\code{p_depends_reverse} - Get \href{http://cran.r-project.org/}{CRAN} or +\code{p_depends_reverse} - Get \href{http://cran.r-project.org/}{CRAN} or local reverse dependencies. } \examples{ @@ -43,7 +43,7 @@ p_depends_reverse(lattice) p_depends(pacman) p_depends_reverse("pacman") -## local dependencies +## local dependencies p_depends(pacman, local = TRUE) p_depends_reverse("qdap", local = TRUE) } diff --git a/man/p_detectOS.Rd b/man/p_detectOS.Rd index ac11d5d..f7dc2c9 100644 --- a/man/p_detectOS.Rd +++ b/man/p_detectOS.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_detectOS.R \name{p_detectOS} \alias{p_detectOS} diff --git a/man/p_exists.Rd b/man/p_exists.Rd index f3c6015..13843df 100644 --- a/man/p_exists.Rd +++ b/man/p_exists.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_exists.R \name{p_exists} \alias{p_exists} @@ -9,8 +9,8 @@ p_exists(package, local = FALSE) \arguments{ \item{package}{Name of package.} -\item{local}{logical. If \code{TRUE} checks user's local library for -existence; if \code{FALSE} \href{http://cran.r-project.org/}{CRAN} for the +\item{local}{logical. If \code{TRUE} checks user's local library for +existence; if \code{FALSE} \href{http://cran.r-project.org/}{CRAN} for the package.} } \description{ diff --git a/man/p_extract.Rd b/man/p_extract.Rd index fe77d43..a77ecd3 100644 --- a/man/p_extract.Rd +++ b/man/p_extract.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_extract.R \name{p_extract} \alias{p_extract} @@ -10,15 +10,15 @@ p_extract(x, use.names = TRUE) \item{x}{A character string of packages separated by commas; for example the strings returned from \code{\link[pacman]{p_information}}.} -\item{use.names}{logical. If \code{TRUE} package names, including version +\item{use.names}{logical. If \code{TRUE} package names, including version number, are used.} } \value{ Returns a character vector of packages. } \description{ -\code{p_extract} is designed to be used in conjunction with -\code{\link[pacman]{p_information}} to convert a single comma separated +\code{p_extract} is designed to be used in conjunction with +\code{\link[pacman]{p_information}} to convert a single comma separated string into a vector of package names. } \examples{ diff --git a/man/p_functions.Rd b/man/p_functions.Rd index a8e240a..334566a 100644 --- a/man/p_functions.Rd +++ b/man/p_functions.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_functions.R \name{p_functions} \alias{p_functions} @@ -12,10 +12,10 @@ p_funs(package = "base", all = FALSE, character.only = FALSE) \arguments{ \item{package}{Name of the package you want the list of functions for.} -\item{all}{logical. If \code{TRUE} all of the functions from the package +\item{all}{logical. If \code{TRUE} all of the functions from the package will be displayed regardless of whether they're exported or not.} -\item{character.only}{logical. If \code{TRUE} the input is a variable +\item{character.only}{logical. If \code{TRUE} the input is a variable containing the package name.} } \description{ diff --git a/man/p_help.Rd b/man/p_help.Rd index 58e5428..67476d8 100644 --- a/man/p_help.Rd +++ b/man/p_help.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_help.R \name{p_help} \alias{p_help} @@ -9,10 +9,10 @@ p_help(package = NULL, web = TRUE, build.pdf = FALSE) \arguments{ \item{package}{Name of package.} -\item{web}{logical. If \code{TRUE} grabs current pdf help manual from the +\item{web}{logical. If \code{TRUE} grabs current pdf help manual from the web (\code{pdf} argument is ignored).} -\item{build.pdf}{logical. If \code{TRUE} attempts to locate the file first +\item{build.pdf}{logical. If \code{TRUE} attempts to locate the file first and ten uses a LaTeX compiler to generate a pdf.} } \description{ @@ -20,8 +20,8 @@ Generate an html, web or pdf of a package's help manual. } \section{Warning}{ -Setting \code{build.pdf = TRUE} requires the user to have a pdf compiler (e.g., -\href{http://miktex.org/}{MikTex} or +Setting \code{build.pdf = TRUE} requires the user to have a pdf compiler (e.g., +\href{http://miktex.org/}{MikTex} or \href{https://www.tug.org/texlive/}{Tex Live}) installed. } \examples{ diff --git a/man/p_information.Rd b/man/p_information.Rd index 61cd1b3..09c170f 100644 --- a/man/p_information.Rd +++ b/man/p_information.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_information.R \name{p_information} \alias{p_info} @@ -10,7 +10,7 @@ p_information(package = "base", ..., fields = NULL) p_info(package = "base", ..., fields = NULL) } \arguments{ -\item{package}{Name of the package to grab information for. Default is +\item{package}{Name of the package to grab information for. Default is \code{"base"}.} \item{fields}{A character vector giving the tags of fields to return (for use @@ -22,9 +22,9 @@ inside of functions rather than \ldots).} Returns a list of fields. } \description{ -Provides the information from for a package from -the \emph{NAMESPACE}. Information may include: title, -version, author, maintainer, description, depends, +Provides the information from for a package from +the \emph{NAMESPACE}. Information may include: title, +version, author, maintainer, description, depends, imports, suggests } \note{ @@ -48,7 +48,7 @@ lapply(p_info(ggplot2, "Imports", "Depends", "Suggests"), p_extract) } } \seealso{ -\code{\link[utils]{packageDescription}}, +\code{\link[utils]{packageDescription}}, \code{\link[pacman]{p_information}} } \keyword{info} diff --git a/man/p_install.Rd b/man/p_install.Rd index 029fbce..60274b2 100644 --- a/man/p_install.Rd +++ b/man/p_install.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_install.R \name{p_install} \alias{p_get} @@ -14,11 +14,11 @@ p_get(package, character.only = FALSE, path = getOption("download_path"), \arguments{ \item{package}{Name of package(s).} -\item{character.only}{logical. If \code{TRUE} \code{\dots} is treated a +\item{character.only}{logical. If \code{TRUE} \code{\dots} is treated a character string.} -\item{path}{The path to the directory that contains the package. It is -convenient to set \code{download_path} in .Rprofile options to the downloads +\item{path}{The path to the directory that contains the package. It is +convenient to set \code{download_path} in .Rprofile options to the downloads directory.} \item{\ldots}{Additional parameters to pass to \code{install.packages}.} diff --git a/man/p_install_gh.Rd b/man/p_install_gh.Rd index e41a26e..c1cfe61 100644 --- a/man/p_install_gh.Rd +++ b/man/p_install_gh.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_install_gh.R \name{p_install_gh} \alias{p_install_gh} @@ -7,8 +7,8 @@ p_install_gh(package, ...) } \arguments{ -\item{package}{Repository address(es) in the format -\code{username/repo[/subdir][@ref|#pull]}. +\item{package}{Repository address(es) in the format +\code{username/repo[/subdir][@ref|#pull]}. Note that this must be a character string.} \item{\ldots}{Additional parameters to pass to \code{\link[devtools]{install_github}}.} diff --git a/man/p_install_version.Rd b/man/p_install_version.Rd index ab05c72..c9fcd89 100644 --- a/man/p_install_version.Rd +++ b/man/p_install_version.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_install_version.R \name{p_install_version} \alias{p_install_version} @@ -7,10 +7,10 @@ p_install_version(package, version) } \arguments{ -\item{package}{\code{character} vector of the name of the package(s) you want +\item{package}{\code{character} vector of the name of the package(s) you want to install a particular minimal version of.} -\item{version}{Corresponding \code{character} vector of the minimal +\item{version}{Corresponding \code{character} vector of the minimal package version(s).} } \description{ @@ -18,7 +18,7 @@ Install minimal package version(s). } \examples{ p_install_version( - c("pacman", "testthat"), + c("pacman", "testthat"), c("0.2.0", "0.9.1") ) } diff --git a/man/p_install_version_gh.Rd b/man/p_install_version_gh.Rd new file mode 100644 index 0000000..6344484 --- /dev/null +++ b/man/p_install_version_gh.Rd @@ -0,0 +1,27 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/p_install_version_gh.R +\name{p_install_version_gh} +\alias{p_install_version_gh} +\title{Install Minimal GitHub Package Version} +\usage{ +p_install_version_gh(package, version) +} +\arguments{ +\item{package}{\code{character} vector of the repository address(es) of the +package(s) you want to install a particular minimal version of. Repository +address(es) in the format \code{username/repo[/subdir][@ref|#pull]}.} + +\item{version}{Corresponding \code{character} vector of the minimal +package version(s).} +} +\description{ +Install minimal GitHub package version(s). +} +\examples{ +p_install_version_gh( + c("trinker/pacman", "hadley/testthat"), + c("0.2.0", "0.9.1") +) +} +\keyword{version} + diff --git a/man/p_interactive.Rd b/man/p_interactive.Rd index 2cd400e..4136cb6 100644 --- a/man/p_interactive.Rd +++ b/man/p_interactive.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_interactive.R \name{p_interactive} \alias{p_inter} @@ -10,7 +10,7 @@ p_interactive() p_inter() } \description{ -Interactively search through packages, looking at functions and optionally +Interactively search through packages, looking at functions and optionally attaching the package and looking at the help page. } \examples{ diff --git a/man/p_isinstalled.Rd b/man/p_isinstalled.Rd index a5f3e3f..96c9068 100644 --- a/man/p_isinstalled.Rd +++ b/man/p_isinstalled.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_isinstalled.R \name{p_isinstalled} \alias{p_isinstalled} diff --git a/man/p_library.Rd b/man/p_library.Rd index d21dbcf..4a868a8 100644 --- a/man/p_library.Rd +++ b/man/p_library.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_library.R \name{p_library} \alias{p_lib} @@ -10,12 +10,12 @@ p_library(open = FALSE) p_lib(open = FALSE) } \arguments{ -\item{open}{logical. If \code{TRUE} opens the directory of the add on +\item{open}{logical. If \code{TRUE} opens the directory of the add on packages library.} } \description{ -Generates a vector of all packages available to the user and optionally opens -the user's library (this isn't necessarily where all of the available +Generates a vector of all packages available to the user and optionally opens +the user's library (this isn't necessarily where all of the available packages are stored). } \examples{ diff --git a/man/p_load.Rd b/man/p_load.Rd index e188322..13db6cc 100644 --- a/man/p_load.Rd +++ b/man/p_load.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_load.R \name{p_load} \alias{p_load} @@ -9,27 +9,27 @@ p_load(..., char, install = TRUE, update = getOption("pac_update"), } \arguments{ \item{char}{Character vector containing packages to load. If you are calling -\code{p_load} from within a function (or just having difficulties calling it -using a character vector input) then pass your character vector of packages +\code{p_load} from within a function (or just having difficulties calling it +using a character vector input) then pass your character vector of packages to load to this parameter directly.} -\item{install}{logical. If \code{TRUE} will attempt to install a package not +\item{install}{logical. If \code{TRUE} will attempt to install a package not found in the library.} -\item{update}{logical. If \code{TRUE} will attempt to update all out of date -packages. Default allows the user to set a \code{"pac_update"} in his/her +\item{update}{logical. If \code{TRUE} will attempt to update all out of date +packages. Default allows the user to set a \code{"pac_update"} in his/her .Rprofile.} -\item{character.only}{logical. If \code{TRUE} then \code{p_load} will only -accept a single input which is a character vector containing the names of +\item{character.only}{logical. If \code{TRUE} then \code{p_load} will only +accept a single input which is a character vector containing the names of packages to load.} \item{\ldots}{name(s) of package(s).} } \description{ -This function is a wrapper for \code{\link[base]{library}} and -\code{\link[base]{require}}. It checks to see if a -package is installed, if not it attempts to install the package from CRAN +This function is a wrapper for \code{\link[base]{library}} and +\code{\link[base]{require}}. It checks to see if a +package is installed, if not it attempts to install the package from CRAN and/or any other repository in the \pkg{pacman} repository list. } \examples{ diff --git a/man/p_load_gh.Rd b/man/p_load_gh.Rd index cdc2990..60d8898 100644 --- a/man/p_load_gh.Rd +++ b/man/p_load_gh.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_load_gh.R \name{p_load_gh} \alias{p_load_gh} @@ -8,24 +8,24 @@ p_load_gh(..., char, install = TRUE, update = getOption("pac_update")) } \arguments{ \item{char}{Character vector containing repository address to load. If you are calling -\code{p_load_gh} from within a function (or just having difficulties calling it -using a character vector input) then pass your character vector of packages +\code{p_load_gh} from within a function (or just having difficulties calling it +using a character vector input) then pass your character vector of packages to load to this parameter directly.} -\item{install}{logical. If \code{TRUE} will attempt to install a package not +\item{install}{logical. If \code{TRUE} will attempt to install a package not found in the library.} -\item{update}{logical. If \code{TRUE} will attempt to update all out of date -packages. Default allows the user to set a \code{"pac_update"} in his/her +\item{update}{logical. If \code{TRUE} will attempt to update all out of date +packages. Default allows the user to set a \code{"pac_update"} in his/her .Rprofile.} -\item{\ldots}{Repository address(es) in the format +\item{\ldots}{Repository address(es) in the format \code{username/repo[/subdir][@ref|#pull]}. Note that this must be a character string.} } \description{ -This function is a wrapper for \code{\link[devtools]{install_github}} and -\code{\link[base]{require}}. It checks to see if a -package is installed, if not it attempts to install the package from +This function is a wrapper for \code{\link[devtools]{install_github}} and +\code{\link[base]{require}}. It checks to see if a +package is installed, if not it attempts to install the package from \href{https://github.com}{GitHub}. } \examples{ diff --git a/man/p_loaded.Rd b/man/p_loaded.Rd index d8b4092..c645b95 100644 --- a/man/p_loaded.Rd +++ b/man/p_loaded.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_loaded.R \name{p_loaded} \alias{p_isloaded} @@ -10,20 +10,20 @@ p_loaded(..., all = FALSE, char, character.only = FALSE) p_isloaded(...) } \arguments{ -\item{all}{logical. If \code{TRUE} will show all packages +\item{all}{logical. If \code{TRUE} will show all packages including base install; \code{FALSE} will show all packages excluding base install packages that install when R loads.} \item{char}{Character vector containing packages to load. If you are calling -\code{p_loaded} from within a function (or just having difficulties calling it -using a character vector input) then pass your character vector of packages +\code{p_loaded} from within a function (or just having difficulties calling it +using a character vector input) then pass your character vector of packages to load to this parameter directly.} -\item{character.only}{logical. If \code{TRUE} then \code{p_loaded} will only -accept a single input which is a character vector containing the names of +\item{character.only}{logical. If \code{TRUE} then \code{p_loaded} will only +accept a single input which is a character vector containing the names of packages to load.} -\item{\ldots}{Optional package names. Adding package names will check their +\item{\ldots}{Optional package names. Adding package names will check their individual load status.} } \description{ diff --git a/man/p_news.Rd b/man/p_news.Rd index 823637e..28fa079 100644 --- a/man/p_news.Rd +++ b/man/p_news.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_news.R \name{p_news} \alias{p_news} @@ -16,7 +16,7 @@ Find out news on a package or R. p_news() p_news(lattice) ## Grab specific version subsets -subset(p_news(lattice), Version == 0.7) +subset(p_news(lattice), Version == 0.7) } \seealso{ \code{\link[utils]{news}} diff --git a/man/p_old.Rd b/man/p_old.Rd index c49348c..58d85c4 100644 --- a/man/p_old.Rd +++ b/man/p_old.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_old.R \name{p_old} \alias{p_old} diff --git a/man/p_opendir.Rd b/man/p_opendir.Rd index ee71aab..1428c80 100644 --- a/man/p_opendir.Rd +++ b/man/p_opendir.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_opendir.R \name{p_opendir} \alias{p_opendir} diff --git a/man/p_path.Rd b/man/p_path.Rd index 8bbef59..8059d7e 100644 --- a/man/p_path.Rd +++ b/man/p_path.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_path.R \name{p_path} \alias{p_path} @@ -7,7 +7,7 @@ p_path(package = "R") } \arguments{ -\item{package}{Name of package (default returns path to library of add-on +\item{package}{Name of package (default returns path to library of add-on packages).} } \description{ diff --git a/man/p_search_any.Rd b/man/p_search_any.Rd index 7787dd4..05c1e23 100644 --- a/man/p_search_any.Rd +++ b/man/p_search_any.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_search_any.R \name{p_search_any} \alias{p_sa} @@ -12,17 +12,17 @@ p_sa(term, search.by = "Maintainer") \arguments{ \item{term}{A search term (character string).} -\item{search.by}{The variable to search by (takes -a integer or a character string): 1-\code{"Maintainer"}, +\item{search.by}{The variable to search by (takes +a integer or a character string): 1-\code{"Maintainer"}, 1-\code{"Author"}, 2-\code{"Package"}, 3-\code{"Version"}} } \description{ -Uses \code{\link[base]{agrep}} to find packages by +Uses \code{\link[base]{agrep}} to find packages by maintainer (often this is the author as well) or by name. } \details{ -Useful for finding packages by the same author (usually the same as -the maintainer). This function will take some time as the function +Useful for finding packages by the same author (usually the same as +the maintainer). This function will take some time as the function is searching thousands of packages via CRAN's website. } \examples{ diff --git a/man/p_search_library.Rd b/man/p_search_library.Rd index c144cb4..f8663e5 100644 --- a/man/p_search_library.Rd +++ b/man/p_search_library.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_search_library.R \name{p_search_library} \alias{p_search_library} @@ -10,16 +10,16 @@ p_search_library(begins.with = NULL, contains = NULL) p_sl(begins.with = NULL, contains = NULL) } \arguments{ -\item{begins.with}{A character string to search for packages starting with +\item{begins.with}{A character string to search for packages starting with the letter(s).} -\item{contains}{A character string to search for packages containing the +\item{contains}{A character string to search for packages containing the letter(s).} } \description{ -Search library packages using partial matching. Search for packages by -partial matching letter(s) or by any letter(s) contained within the package's -name. Useful for those times when you can't remember that package name but +Search library packages using partial matching. Search for packages by +partial matching letter(s) or by any letter(s) contained within the package's +name. Useful for those times when you can't remember that package name but you know ``it starts with...'' } \examples{ diff --git a/man/p_set_cranrepo.Rd b/man/p_set_cranrepo.Rd index 04f32b9..f7f91a4 100644 --- a/man/p_set_cranrepo.Rd +++ b/man/p_set_cranrepo.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_set_cranrepo.R \name{p_set_cranrepo} \alias{p_set_cranrepo} diff --git a/man/p_temp.Rd b/man/p_temp.Rd index cdd9d5a..aaaf98b 100644 --- a/man/p_temp.Rd +++ b/man/p_temp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_temp.R \name{p_temp} \alias{p_temp} diff --git a/man/p_unload.Rd b/man/p_unload.Rd index ff1c415..373e213 100644 --- a/man/p_unload.Rd +++ b/man/p_unload.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_unload.R \name{p_unload} \alias{p_unload} @@ -11,12 +11,12 @@ p_unload(..., negate = FALSE, char, character.only = FALSE) all add on packages except those provided to \code{p_unload}.} \item{char}{Character vector containing packages to load. If you are calling -\code{p_unload} from within a function (or just having difficulties calling it -using a character vector input) then pass your character vector of packages +\code{p_unload} from within a function (or just having difficulties calling it +using a character vector input) then pass your character vector of packages to load to this parameter directly.} -\item{character.only}{logical. If \code{TRUE} then \code{p_unload} will only -accept a single input which is a character vector containing the names of +\item{character.only}{logical. If \code{TRUE} then \code{p_unload} will only +accept a single input which is a character vector containing the names of packages to load.} \item{\dots}{name of package(s) or "all" (all removes all add on packages).} @@ -25,8 +25,8 @@ packages to load.} Unloads package(s) or all packages. } \note{ -\code{p_unload} will not unload the base install packages that load -when R boots up. See the comments in the help for \code{detach} about some +\code{p_unload} will not unload the base install packages that load +when R boots up. See the comments in the help for \code{detach} about some issues with unloading and reloading namespaces. } \examples{ diff --git a/man/p_unlock.Rd b/man/p_unlock.Rd index f1b405b..19974f6 100644 --- a/man/p_unlock.Rd +++ b/man/p_unlock.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_unlock.R \name{p_unlock} \alias{p_unlock} @@ -10,18 +10,18 @@ p_unlock(lib.loc = p_path()) \item{lib.loc}{Path to library location.} } \value{ -Attempts to delete a 00LOCK(s) if it exists. Returns logical +Attempts to delete a 00LOCK(s) if it exists. Returns logical \code{TRUE} if a 00LOCK existed and \code{FALSE} if not. } \description{ -Deletes the 00LOCK directory accidentally left behind by a fail in +Deletes the 00LOCK directory accidentally left behind by a fail in \code{\link[utils]{install.packages}}. } \details{ -Sometimes \code{\link[utils]{install.packages}} can "fail so badly -that the lock directory is not removed: this inhibits any further installs to -the library directory (or for --pkglock, of the package) until the lock -directory is removed manually." \code{p_unlock} deletes the directory +Sometimes \code{\link[utils]{install.packages}} can "fail so badly +that the lock directory is not removed: this inhibits any further installs to +the library directory (or for --pkglock, of the package) until the lock +directory is removed manually." \code{p_unlock} deletes the directory 00LOCK that is left behind. } \examples{ diff --git a/man/p_update.Rd b/man/p_update.Rd index ed5457f..4495b57 100644 --- a/man/p_update.Rd +++ b/man/p_update.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_update.R \name{p_update} \alias{p_up} @@ -10,12 +10,12 @@ p_update(update = TRUE, ask = FALSE, ...) p_up(update = TRUE, ask = FALSE, ...) } \arguments{ -\item{update}{logical. If \code{TRUE} updates any out-of-date packages; if +\item{update}{logical. If \code{TRUE} updates any out-of-date packages; if \code{FALSE} returns a list of out-of-date packages.} -\item{ask}{logical. If \code{TRUE} asks user before packages are actually -downloaded and installed, or the character string \code{"graphics"}, which -brings up a widget to allow the user to (de-)select from the list of packages +\item{ask}{logical. If \code{TRUE} asks user before packages are actually +downloaded and installed, or the character string \code{"graphics"}, which +brings up a widget to allow the user to (de-)select from the list of packages which could be updated or added.} \item{\ldots}{Other arguments passed to \code{\link[utils]{update.packages}}.} diff --git a/man/p_version.Rd b/man/p_version.Rd index 25387be..c863c14 100644 --- a/man/p_version.Rd +++ b/man/p_version.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_version.R \name{p_version} \alias{p_ver} @@ -29,7 +29,7 @@ p_ver_diff(package = "R") \code{p_version_cran} - Determine what version a package is on CRAN. -\code{p_version_difference} - Determine version difference between a local +\code{p_version_difference} - Determine version difference between a local package and CRAN. } \examples{ diff --git a/man/p_vignette.Rd b/man/p_vignette.Rd index 528e8d7..872636b 100644 --- a/man/p_vignette.Rd +++ b/man/p_vignette.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_vignette.R \name{p_vignette} \alias{p_vign} @@ -10,22 +10,22 @@ p_vignette(..., char, interactive = TRUE, character.only = FALSE) p_vign(..., char, interactive = TRUE, character.only = FALSE) } \arguments{ -\item{char}{Character vector containing packages to find vignettes for. If -you are calling \code{p_vignette} from within a function (or just having -difficulties calling it using a character vector input) then pass your +\item{char}{Character vector containing packages to find vignettes for. If +you are calling \code{p_vignette} from within a function (or just having +difficulties calling it using a character vector input) then pass your character vector of packages to this parameter directly.} -\item{interactive}{logical. If \code{TRUE} will generate an HTML list of +\item{interactive}{logical. If \code{TRUE} will generate an HTML list of selections.} -\item{character.only}{logical. If \code{TRUE} then \code{p_vignette} will -only accept a single input which is a character vector containing the names +\item{character.only}{logical. If \code{TRUE} then \code{p_vignette} will +only accept a single input which is a character vector containing the names of packages to find vignettes for.} \item{\ldots}{name(s) of package(s).} } \description{ -Interactively view vignettes for package(s) or return a dataframe of +Interactively view vignettes for package(s) or return a dataframe of vignettes and accompanying information. } \examples{ diff --git a/man/print.p_version_diff.Rd b/man/print.p_version_diff.Rd index c79904a..8824ebf 100644 --- a/man/print.p_version_diff.Rd +++ b/man/print.p_version_diff.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_version.R \name{print.p_version_diff} \alias{print.p_version_diff} diff --git a/man/print.search_any.Rd b/man/print.search_any.Rd index f2ddf0e..ae44824 100644 --- a/man/print.search_any.Rd +++ b/man/print.search_any.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_search_any.R \name{print.search_any} \alias{print.search_any} diff --git a/man/print.wide_table.Rd b/man/print.wide_table.Rd index 16420c2..f387c70 100644 --- a/man/print.wide_table.Rd +++ b/man/print.wide_table.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2: do not edit by hand % Please edit documentation in R/p_data.R \name{print.wide_table} \alias{print.wide_table} From 7b45eaaae8da98b18948577ebec81403ffb034be Mon Sep 17 00:00:00 2001 From: Tyler Rinker Date: Thu, 10 Mar 2016 13:23:05 -0500 Subject: [PATCH 2/4] Updated news --- DESCRIPTION | 27 +++++++++------------------ NEWS.md | 11 ++++++----- 2 files changed, 15 insertions(+), 23 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index cbad63b..1706fee 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,33 +2,24 @@ Package: pacman Type: Package Title: Package Management Tool Version: 0.4.0 -Date: 2016-03-05 +Date: 2016-03-10 Authors@R: c(person("Tyler", "Rinker", role = c("aut", "cre", "ctb"), email = "tyler.rinker@gmail.com"), person("Dason", "Kurkiewicz", role = c("aut", "ctb"), email = "dasonk@iastate.edu"), person("Keith", "Hughitt", role = c("ctb"))) Author: Tyler Rinker [aut, cre, ctb], Dason Kurkiewicz [aut, ctb], - Keith Hughitt [ctb] + Keith Hughitt [ctb] Maintainer: Tyler Rinker -Depends: - R (>= 2.13.0) -Imports: - devtools, - methods, - stats, - utils -Suggests: - knitr, - lattice, - testthat (>= 0.9.0), - XML +Depends: R (>= 2.13.0) +Imports: devtools, methods, stats, utils +Suggests: knitr, lattice, testthat (>= 0.9.0), XML BugReports: https://github.com/trinker/pacman/issues?state=open Description: Tools to more conveniently perform tasks associated with - add-on packages. pacman conveniently wraps library and package - related functions and names them in an intuitive and consistent - fashion. It seeks to combine functionality from lower level - functions which can speed up workflow. + add-on packages. pacman conveniently wraps library and package + related functions and names them in an intuitive and consistent + fashion. It seeks to combine functionality from lower level + functions which can speed up workflow. License: GPL-2 URL: https://github.com/trinker/pacman Roxygen: list(wrap = FALSE) diff --git a/NEWS.md b/NEWS.md index caf653b..b4c485f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -26,9 +26,9 @@ And constructed with the following guidelines: * Support for Bioconductor packages added compiments of Keith Hughitt. See #62 -* `p_boot` added to generate a string for the standard pacman script header - that, when added to scripts, will ensure pacman is installed before - attempting to use it. pacman will attempt to copy this string (standard +* `p_boot` added to generate a string for the standard **pacman** script header + that, when added to scripts, will ensure **pacman** is installed before + attempting to use it. **pacman** will attempt to copy this string (standard script header) to the clipboard for easy cut and paste. * `p_version_cran` (`p_ver_cran`) added to check R/package version currently @@ -37,9 +37,10 @@ And constructed with the following guidelines: * `p_version_diff` (`p_ver_diff`) added to determine version difference between a local package and CRAN. +* `p_old` added to search for outdated packages. + * `p_install_version_gh` added as a partner to `p_install_version` for GitHub - packages. Thanks to Steve Simpson for this: https://github.com/trinker/pacman/issues/70 - + packages. Thanks to Steve Simpson for this: https://github.com/trinker/pacman/issues/70 **MINOR FEATURES** From 6dde8634dc0f89f16fa85260f46e1503ec89e8bd Mon Sep 17 00:00:00 2001 From: Tyler Rinker Date: Tue, 29 Mar 2016 09:46:50 -0400 Subject: [PATCH 3/4] Update test-p_install.R --- tests/testthat/test-p_install.R | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/testthat/test-p_install.R b/tests/testthat/test-p_install.R index 45b6ec4..9a5f308 100644 --- a/tests/testthat/test-p_install.R +++ b/tests/testthat/test-p_install.R @@ -1,8 +1,9 @@ context("Checking p_install") test_that("p_install works",{ + skip_on_travis() require(pacman) expect_warning(p_install("iDontExistAnywhere")) tmp <- suppressWarnings(p_install("iDontExistAnywhere")) expect_false(tmp) -}) \ No newline at end of file +}) From fc2492d4a922922a24c61d7bd7b446aa53bdcb37 Mon Sep 17 00:00:00 2001 From: Tyler Rinker Date: Tue, 29 Mar 2016 10:05:27 -0400 Subject: [PATCH 4/4] Update test-p_install.R --- tests/testthat/test-p_install.R | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/testthat/test-p_install.R b/tests/testthat/test-p_install.R index 9a5f308..5f6fb86 100644 --- a/tests/testthat/test-p_install.R +++ b/tests/testthat/test-p_install.R @@ -1,6 +1,7 @@ context("Checking p_install") test_that("p_install works",{ + skip_on_cran() skip_on_travis() require(pacman) expect_warning(p_install("iDontExistAnywhere"))