help.pages: Locate URL links of Installed Packages

In yonicd/helpdesk: Query URL links embedded in Installed Packages

Description

Search for packages and functions for the URL documentation as listed in the package DESCRIPTION files

Usage

help.pages(package = get_installed(), function_pattern = NULL,
  regex = FALSE, DT_args = list(options = list(paging = FALSE, dom =
  "t")))

Arguments

package	character, names of pacakges to query, Default: full_stack
function_pattern	character, pattern of functions to query within the packages queried, Default: NULL
regex	logical. If TRUE then package pattern is matched against the list of installed package names, Default: FALSE
DT_args	list, arguments to pass to datatable on print

Details

full_stack is created by the package on attachment/loading consists a vector of the installed packages on the machine.

Value

data.frame of class help_pages

See Also

desc_get_urls

Examples

## Not run: 
if(interactive()){

  # return all packages with URLS
  help.pages()

  # return a specific subset of installed packages
  help.pages(package = c('tidyr','tidytext'))

  # search by partial match of pacakge names
  help.pages(package = 'tidy',regex = TRUE)

  # search by function pattern
  help.pages(function_pattern = 'geom')

 }

## End(Not run)

yonicd/helpdesk documentation built on Nov. 5, 2019, 1:21 p.m.