Skip to content

Commit

Permalink
Ran roxygenize
Browse files Browse the repository at this point in the history
  • Loading branch information
Dason Kurkiewicz committed Jun 3, 2012
1 parent 8aeed1a commit 793fba0
Show file tree
Hide file tree
Showing 44 changed files with 455 additions and 529 deletions.
38 changes: 34 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,12 +1,42 @@
Package: pacman
Type: Package
Title: Package Management Tool
Version: 0.1.0
Version: 0.2.0
Date: 2012-05-09
Author: Tyler Rinker & Dason Kurkiewicz
Maintainer: Tyler Rinker <[email protected]>
Depends: R (>= 2.15.0)
Suggests: XML
Description: This package is a designed to more efficiently manage 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 that can speed up workflow.
Depends:
R (>= 2.15.0)
Suggests:
XML
Description: This package is a designed to more efficiently manage 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 that can speed up workflow.
License: GPL-2
URL: http://trinkerrstuff.wordpress.com/
Collate:
'p_author.R'
'p_base.R'
'p_citation.R'
'p_cran.R'
'p_data.R'
'p_delete.R'
'p_exists.R'
'p_functions.R'
'p_getXML.R'
'p_help.R'
'p_information.R'
'p_install.R'
'p_interactive.R'
'p_library.R'
'p_load.R'
'p_loaded.R'
'p_news.R'
'p_path.R'
'p_search_any.R'
'p_search_library.R'
'p_unload.R'
'p_update.R'
'p_version.R'
'p_vignette.R'
63 changes: 30 additions & 33 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,39 +1,36 @@

export(p_author)
export(p_base)
export(p_citation)
export(p_cite)
export(p_cran)
export(p_data)
export(p_delete)
export(p_del)
export(p_exists)
export(p_functions)
export(p_author)
export(p_base)
export(p_citation)
export(p_cite)
export(p_cran)
export(p_data)
export(p_del)
export(p_delete)
export(p_exists)
export(p_functions)
export(p_funs)
export(p_get)
export(p_get)
export(p_getXML)
export(p_help)
export(p_information)
export(p_help)
export(p_info)
export(p_information)
export(p_install)
export(p_interactive)
export(p_inter)
export(p_library)
export(p_lib)
export(p_load)
export(p_loaded)
export(p_news)
export(p_path)
export(p_unload)
export(p_search_any)
export(p_sa)
export(p_search_library)
export(p_sl)
export(p_update)
export(p_version)
export(p_interactive)
export(p_lib)
export(p_library)
export(p_load)
export(p_loaded)
export(p_news)
export(p_path)
export(p_sa)
export(p_search_any)
export(p_search_library)
export(p_sl)
export(p_unload)
export(p_up)
export(p_update)
export(p_ver)
export(p_vignette)
export(p_vign)



export(p_version)
export(p_vign)
export(p_vignette)
2 changes: 1 addition & 1 deletion R/p_base.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ function(open = FALSE){
}
cat('\npackages with an "*" are loaded when R starts\n\n')
return(z)
}
}
3 changes: 2 additions & 1 deletion R/p_citation.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ function(package="r") {
}
}

p_cite <- p_citation
#' @export
p_cite <- p_citation
3 changes: 2 additions & 1 deletion R/p_delete.R
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,5 @@ function (...)
}
}

p_del <- p_delete
#' @export
p_del <- p_delete
2 changes: 1 addition & 1 deletion R/p_exists.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ function (package, cran = TRUE)
} else {
x %in% list.files(.libPaths())
}
}
}
3 changes: 2 additions & 1 deletion R/p_functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,5 @@ function (package = NULL, load = FALSE)
return(a)
}

p_funs <- p_functions
#' @export
p_funs <- p_functions
2 changes: 1 addition & 1 deletion R/p_getXML.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ function(package="XML", fun){
}else{
cat("Please download the XML package before using", fun, "\n")
}
}
}
2 changes: 1 addition & 1 deletion R/p_help.R
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ function (package = NULL, web = FALSE, pdf = FALSE)
}
}
}
}
}
3 changes: 2 additions & 1 deletion R/p_information.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ function(package=NULL) {
packageDescription(x)
}

p_info <- p_information
#' @export
p_info <- p_information
3 changes: 2 additions & 1 deletion R/p_install.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ function(package){
do.call('library', list(pack))
}

p_get <- p_install
#' @export
p_get <- p_install
3 changes: 2 additions & 1 deletion R/p_interactive.R
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ function() {
cat("Thank you for using the p_interactive function!\n\n")
}

p_inter <- p_interactive
#' @export
p_inter <- p_interactive
3 changes: 2 additions & 1 deletion R/p_library.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ function (open = FALSE)
return(y)
}

p_lib <- p_library
#' @export
p_lib <- p_library
4 changes: 2 additions & 2 deletions R/p_path.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
#'
#' See path to library of add on package
#'
#' @alias p_path
#' @aliases p_path
#' @seealso \code{\link[base]{.libPaths}}
#' @keyword package library location path
#' @keywords package library location path
#' @export
#' @examples
#' p_path()
Expand Down
5 changes: 3 additions & 2 deletions R/p_search_any.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#' Uses agrep to find packages by
#' maintainer (often this is the author as well) or by name
#'
#' @alias p_search_any p_sa
#' @aliases p_search_any p_sa
#' @param term A search character string
#' @param search.by The variable to search by (takes
#' a integer or a character string): 1-"Maintainer",
Expand Down Expand Up @@ -53,4 +53,5 @@ function (term, search.by = "Maintainer")
}
}

p_sa <- p_search_any
#' @export
p_sa <- p_search_any
3 changes: 2 additions & 1 deletion R/p_search_library.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,5 @@ function(begins.with = NULL, contains = NULL){
cat(x, "loaded\n")
}

p_sl <- p_search_library
#' @export
p_sl <- p_search_library
2 changes: 1 addition & 1 deletion R/p_unload.R
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ function (..., negate = FALSE)
cat("The following packages have been unloaded:\n", paste0("\b",
paste(y, collapse = ", ")), "\n")
}
}
}
3 changes: 2 additions & 1 deletion R/p_update.R
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ function (install = TRUE) {
}
}

p_up <- p_update
#' @export
p_up <- p_update
3 changes: 2 additions & 1 deletion R/p_version.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ function(package="R") {
}
}

p_ver <- p_version
#' @export
p_ver <- p_version
3 changes: 2 additions & 1 deletion R/p_vignette.R
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,5 @@ function(package = "all"){
" or a the name of a package that has a vignette"))
}

p_vign <- p_vignette
#' @export
p_vign <- p_vignette
25 changes: 9 additions & 16 deletions man/p_author.Rd
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@
\name{p_author}
\alias{p_author}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{
Returns the author of a package
}
\description{
Returns the author of a package
}
\title{Returns the author of a package}
\usage{
p_author(package = "base")
p_author(package = "base")
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{package}{
name of package
}
\item{package}{name of package}
}
\seealso{
\code{\link[utils]{packageDescription}}
\description{
Returns the author of a package
}
\examples{
p_author(pacman)
p_author()
}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
\seealso{
\code{\link[utils]{packageDescription}}
}
\keyword{author}
\keyword{package}

32 changes: 13 additions & 19 deletions man/p_base.Rd
Original file line number Diff line number Diff line change
@@ -1,33 +1,27 @@
\name{p_base}
\alias{p_base}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{
List all the packages in a base install
}
\description{
List all the packages in a base install
}
\title{List all the packages in a base install}
\usage{
p_base(open=FALSE)
%- maybe also 'usage' for other objects documented here.
p_base(open = FALSE)
}
\arguments{
\item{open}{
logical. If TRUE opens the directory of the base install packages
\item{open}{logical. If TRUE opens the directory of the
base install packages}
}
\description{
List all the packages in a base install
}

\note{
PAckages that are installed when R starts are marked with an asterisk(*)
}
\seealso{
\code{\link[base]{getOption}}
Packages that are installed when R starts are marked with
an asterisk(*)
}
\examples{
p_base()
p_base(TRUE)
}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
\seealso{
\code{\link[base]{getOption}}
}
\keyword{base}
\keyword{package}
\keyword{package}

29 changes: 11 additions & 18 deletions man/p_citation.Rd
Original file line number Diff line number Diff line change
@@ -1,31 +1,24 @@
\name{p_citation}
\alias{p_citation}
\alias{p_cite}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{
Generate citation for a package
}
\description{
Generate citation for a package
}
\title{Generate citation for a package}
\usage{
p_citation(package = "r")
p_cite(package = "r")
p_citation(package = "r")
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{package}{
name of package
}
\item{package}{Name of the package you want a citation
for}
}
\seealso{
\code{\link[utils]{citation}}
\description{
Generate citation for a package
}
\examples{
p_cite(pacman)
p_citation(pacman)
}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
\seealso{
\code{\link[utils]{citation}}
}
\keyword{citation}
\keyword{cite}% __ONLY ONE__ keyword per line
\keyword{cite}

Loading

0 comments on commit 793fba0

Please sign in to comment.