GetPkgMeta: Get a package's metadata fields and associated entries.

In mccreigh/rwrfhydro: R tools for the WRF Hydro Model

Description

GetPkgMeta Get metadata fields and associated entries from a package's documentation (e.g. "keyword" or "concepts".)

Usage

GetPkgMeta(meta = c("concept", "keyword"), package = "rwrfhydro",
  keyword = NULL, concept = NULL, quiet = FALSE,
  listMetaOnly = FALSE, byFunction = "")

Arguments

meta	Character the metadata field.
package	Character The package to query for metadata.
keyword	Character A specific keyword to look for.
concept	Character A specific concept to look for.
quiet	Logical Do not print summary to screen.
listMetaOnly	Logical Just return the meta categories (without functons)?
byFunction	Character Vector of functions for which concepts and keywords are desired.

Value

List of metadata fields in alphabetical order with corresponding entries.

Examples

GetPkgMeta()
GetPkgMeta('keyword', package='ggplot2')
GetPkgMeta(concept = 'foo', key='hplot' )
print( GetPkgMeta(concept = c('dataMgmt','foo'), key=c('foo','hplot') , quiet=TRUE))
str( GetPkgMeta(concept = c('dataMgmt','foo'), key=c('foo','hplot') , quiet=TRUE))
str( GetPkgMeta(concept = c('dataMgmt','DART'), key=c('internal','hplot') , quiet=TRUE))
GetPkgMeta(byFunction=c('MkDischargeVariance','SaveHucData'))

mccreigh/rwrfhydro documentation built on Feb. 28, 2021, 1:53 p.m.