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

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

helpdesk r if(knitr::opts_knit$get('rmarkdown.pandoc.to')=='gfm-ascii_identifiers') '<img src="https://github.com/yonicd/helpdesk/raw/master/input/logo.png" align="right" />'

Embedded in the DESCRIPTION files of our installed.packages is a world of URLs developers have curated for us to learn from. The problem many times is that getting to the right link quickly is a pain in the REDACTED.

The goal of helpdesk is to create a simple api to query URL links embedded in DESCRPITION files of the installed.packages and return a search enabled datatable with active links of the relevant URLs.

Installation

remotes::install_github("yonicd/helpdesk")

Example

library(helpdesk)

Interactive

In RStudio IDE an interactive datatable will be returned in which search fields at the top of the columns is enabled by default to further query the output.

After locating the relevant link you need, the links are enabled to open directly into a new browser tab.

Here is an example

Running in the console the default call

help.pages()

The resulting datatable is returned

That's it!

Static

Below shows some additional functionality, where the returned objects are converted to html tables. Like before the links are active so you can test them out from the outputs.

Default

returns a table of all the packages with URLs in the DESCRIPTION file

x <- help.pages()
nrow(x)
knitr::kable(head(x))

Subset of packages

knitr::kable(help.pages(c('dplyr','ggplot2')))

Using partial matches of package names

knitr::kable(help.pages('tidy',regex = TRUE))

Using partial matches of function names in the help title field

knitr::kable(help.pages(function_pattern = 'geom'))

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