Skip to content

Commit

Permalink
Fixed "usage" issue from trinker#9 . Also removed useless @alias tags
Browse files Browse the repository at this point in the history
  • Loading branch information
Dason Kurkiewicz committed Jun 3, 2012
1 parent d543f14 commit 3d2e008
Show file tree
Hide file tree
Showing 35 changed files with 48 additions and 23 deletions.
1 change: 0 additions & 1 deletion R/p_author.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Returns the author of a package
#'
#' @aliases p_author
#' @param package Name of the package you want the author of.
#' @seealso \code{\link[utils]{packageDescription}}
#' @keywords author package
Expand Down
3 changes: 2 additions & 1 deletion R/p_citation.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' Generate citation for a package
#'
#' @aliases p_citation p_cite
#' @rdname p_citation
#' @param package Name of the package you want a citation for
#' @seealso \code{\link[utils]{citation}}
#' @keywords citation cite
Expand All @@ -23,5 +23,6 @@ function(package = "r") {
citation(package = x, lib.loc = NULL, auto = NULL)
}

#' @rdname p_citation
#' @export
p_cite <- p_citation
1 change: 0 additions & 1 deletion R/p_cran.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Generate a vector of all available packages.
#'
#' @aliases p_cran
#' @param menu logical. If TRUE allows user to select
#' the package and return that package name
#' @seealso \code{\link[utils]{available.packages}}
Expand Down
1 change: 0 additions & 1 deletion R/p_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Generate a script of all data sets contained in package.
#'
#' @aliases p_data
#' @param package name of package (default is the base install datasets package)
#' @seealso \code{\link[utils]{data}}
#' @keywords data package
Expand Down
3 changes: 2 additions & 1 deletion R/p_delete.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' Remove package(s) from the library permanently.
#'
#' @aliases p_delete p_del
#' @rdname p_delete
#' @param \ldots name(s) of package(s)
#' @section Warning:
#'
Expand Down Expand Up @@ -55,5 +55,6 @@ function (...)
}
}

#' @rdname p_delete
#' @export
p_del <- p_delete
1 change: 0 additions & 1 deletion R/p_exists.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Checks CRAN to determine if a package exists
#'
#' @aliases p_exists
#' @param package name of package
#' @param cran logical. If TRUE checks CRAN for the package;
#' if FALSE checks the user's local library
Expand Down
3 changes: 2 additions & 1 deletion R/p_functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' List the functions from a package
#'
#' @aliases p_functions p_funs
#' @rdname p_functions
#' @param package Name of the package you want the list of functions for.
#' @param load logical. If TRUE the package will be loaded.
#' @keywords function package
Expand Down Expand Up @@ -36,5 +36,6 @@ function (package = NULL, load = FALSE)
return(a)
}

#' @rdname p_functions
#' @export
p_funs <- p_functions
1 change: 0 additions & 1 deletion R/p_getXML.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
#' Choosing not to download will result in a warning
#' message (and likely will result in an error).
#'
#' @aliases p_getXML
#' @param package Provides the name of XML to the warning
#' @param fun Provides the name of the function getXML is being used in to the warning
#' @keywords XML
Expand Down
1 change: 0 additions & 1 deletion R/p_help.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Generate an html, web or pdf of a package's help manual
#'
#' @aliases p_help
#' @param package name of package
#' @param web logical. If TRUE grabs current help manual from the web
#' @param pdf logical. If TRUE uses a LaTeX compiler to generate a pdf
Expand Down
3 changes: 2 additions & 1 deletion R/p_information.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' version, author, maintainer, description, depends,
#' imports, suggests
#'
#' @aliases p_information p_info
#' @rdname p_information
#' @param package Name of the package you want information on.
#' The default is "base".
#' @keywords packageDescription info information package
Expand All @@ -24,5 +24,6 @@ function(package = "base") {
packageDescription(x)
}

#' @rdname 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 @@ -2,7 +2,7 @@
#'
#' Installs a package provided the package is a CRAN package
#'
#' @aliases p_install p_get
#' @rdname p_install
#' @param package Name of package(s)
#' @keywords install package
#' @seealso \code{\link[utils]{install.packages}}
Expand All @@ -16,5 +16,6 @@ function(package){
do.call('library', list(pack))
}

#' @rdname 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 @@ -4,7 +4,7 @@
#' at functions and optionally attaching the package
#' and looking at the help page.
#'
#' @aliases p_interactive p_inter
#' @rdname p_interactive
#' @keywords package
#' @export
#' @examples
Expand Down Expand Up @@ -36,5 +36,6 @@ function() {
cat("Thank you for using the p_interactive function!\n\n")
}

#' @rdname 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 @@ -3,7 +3,7 @@
#' Generates a vector of all available add on packages
#' in the user's library and optionally opens that directory.
#'
#' @aliases p_library p_lib
#' @rdname p_library
#' @param open logical. If TRUE opens the directory of
#' the add on packages library.
#' @keywords library package
Expand Down Expand Up @@ -33,5 +33,6 @@ function (open = FALSE)
return(y)
}

#' @rdname p_library
#' @export
p_lib <- p_library
1 change: 0 additions & 1 deletion R/p_load.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
#' It checks to see if a package is installed, if not
#' it installs the package(s) and loads it.
#'
#' @aliases p_load
#' @param \ldots name(s) of package(s)
#' @param install logical. If TRUE will attempt to install a package
#' not found in the library
Expand Down
1 change: 0 additions & 1 deletion R/p_loaded.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Output is a character string of loaded packages
#'
#' @aliases p_loaded
#' @param all logical. If TRUE will show all packages
#' including base install; FALSE will show all packages
#' excluding base install packages that install when R loads
Expand Down
1 change: 0 additions & 1 deletion R/p_news.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Find out news on a package
#'
#' @aliases p_news
#' @param package Name of package (default is to see news for R)
#' @seealso \code{\link[utils]{news}}
#' @keywords news packages
Expand Down
1 change: 0 additions & 1 deletion R/p_path.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' See path to library of add on package
#'
#' @aliases p_path
#' @seealso \code{\link[base]{.libPaths}}
#' @keywords package library location path
#' @export
Expand Down
3 changes: 2 additions & 1 deletion 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
#'
#' @aliases p_search_any p_sa
#' @rdname p_search_any
#' @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 @@ -62,5 +62,6 @@ function (term, search.by = "Maintainer")
}
}

#' @rdname 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 @@ -6,7 +6,7 @@
#' Useful for those times when you can't remember
#' that package name but you know ``it starts with...''
#'
#' @aliases p_search_library p_sl
#' @rdname p_search_library
#' @param begins.with a character string to search for
#' packages starting with the letter(s)
#' @param contains a character string to search for
Expand Down Expand Up @@ -46,5 +46,6 @@ function(begins.with = NULL, contains = NULL){
cat(x, "loaded\n")
}

#' @rdname p_search_library
#' @export
p_sl <- p_search_library
1 change: 0 additions & 1 deletion R/p_unload.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
#'
#' Unloads package(s) or all packages
#'
#' @aliases p_unload
#' @param \dots name of package(s) or "all"
#' (all removes all add on packages)
#' @param negate logical. If TRUE will uninstall
Expand Down
3 changes: 2 additions & 1 deletion R/p_update.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' Either view out of date packages or update
#' out of data packages
#'
#' @aliases p_update p_up
#' @rdname p_update
#' @param install logical. If TRUE installs
#' any out of date packages; if FALSE retuns a list
#' of out of date packages
Expand Down Expand Up @@ -38,5 +38,6 @@ function (install = TRUE) {
}
}

#' @rdname 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 @@ -2,7 +2,7 @@
#'
#' Determine what version a package is in your library
#'
#' @aliases p_version p_ver
#' @rdname p_version
#' @param package name of package (default returns R version)
#' @seealso \code{\link[utils]{packageDescription}}
#' @keywords package version
Expand All @@ -21,5 +21,6 @@ function(package="R") {
}
}

#' @rdname 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 @@ -3,7 +3,7 @@
#' Use default "all" to see which packages have vignettes
#' and supply a package name to view that vignette.
#'
#' @aliases p_vignette p_vign
#' @rdname p_vignette
#' @param package name of package or "all" (if all returns
#' all packages from the user's library that have vignettes)
#' @seealso \code{\link[utils]{vignette}}
Expand Down Expand Up @@ -63,5 +63,6 @@ function(package = "all"){
" or a the name of a package that has a vignette"))
}

#' @rdname p_vignette
#' @export
p_vign <- p_vignette
2 changes: 2 additions & 0 deletions man/p_citation.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Generate citation for a package}
\usage{
p_citation(package = "r")

p_cite(package = "r")
}
\arguments{
\item{package}{Name of the package you want a citation
Expand Down
2 changes: 2 additions & 0 deletions man/p_delete.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Remove package(s) from the library}
\usage{
p_delete(...)

p_del(...)
}
\arguments{
\item{\ldots}{name(s) of package(s)}
Expand Down
2 changes: 2 additions & 0 deletions man/p_functions.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{List the functions from a package}
\usage{
p_functions(package = NULL, load = FALSE)

p_funs(package = NULL, load = FALSE)
}
\arguments{
\item{package}{Name of the package you want the list of
Expand Down
2 changes: 2 additions & 0 deletions man/p_information.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{See information on a package.}
\usage{
p_information(package = "base")

p_info(package = "base")
}
\arguments{
\item{package}{Name of the package you want information
Expand Down
2 changes: 2 additions & 0 deletions man/p_install.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Installs and loads a package provided the package is a CRAN package}
\usage{
p_install(package)

p_get(package)
}
\arguments{
\item{package}{Name of package(s)}
Expand Down
2 changes: 2 additions & 0 deletions man/p_interactive.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Interactive package exploration}
\usage{
p_interactive()

p_inter()
}
\description{
Interactively search through packages, looking at
Expand Down
2 changes: 2 additions & 0 deletions man/p_library.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Display library packages}
\usage{
p_library(open = FALSE)

p_lib(open = FALSE)
}
\arguments{
\item{open}{logical. If TRUE opens the directory of the
Expand Down
2 changes: 2 additions & 0 deletions man/p_search_any.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
by similar package names}
\usage{
p_search_any(term, search.by = "Maintainer")

p_sa(term, search.by = "Maintainer")
}
\arguments{
\item{term}{A search character string}
Expand Down
2 changes: 2 additions & 0 deletions man/p_search_library.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Search library packages using partial matching}
\usage{
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
Expand Down
2 changes: 2 additions & 0 deletions man/p_update.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Update out of date packages}
\usage{
p_update(install = TRUE)

p_up(install = TRUE)
}
\arguments{
\item{install}{logical. If TRUE installs any out of date
Expand Down
2 changes: 2 additions & 0 deletions man/p_version.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Determine installed package version}
\usage{
p_version(package = "R")

p_ver(package = "R")
}
\arguments{
\item{package}{name of package (default returns R
Expand Down
2 changes: 2 additions & 0 deletions man/p_vignette.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
\title{Look at a package's vignette}
\usage{
p_vignette(package = "all")
p_vign(package = "all")
}
\arguments{
\item{package}{name of package or "all" (if all returns
Expand Down

0 comments on commit 3d2e008

Please sign in to comment.