R package to integrate rdocumentation.org into your R workflow
R

README.md

rdocumentation_package_banner

Travis-CI Build Status codecov CRAN_Status_Badge Rdoc

Enhance the search/help functionality in R with RDocumentation.org, and discover what R packages are most popular.

Installation

To install the latest stable version from CRAN:

install.packages("RDocumentation")

You can also use devtools to install the latest development version:

devtools::install_github("datacamp/RDocumentation")
library(RDocumentation)

The package overrides the basic help functions from the utils package:

  • help() : for help about specific topic or packages
  • help.search() : for help about fuzzy topics or packages
  • ?: shortcut for the two help functions, one question mark calls help, two calls help.search.

The first time you load RDocumentation, you will be asked to automatically load the package when R starts. If you want to control this afterwards, you can use

enable_autoload()
disable_autoload()

When RDocumentation is loaded in your R session, the help functionality will be overridden to show documentation in RDocuemntation. To enable/disable this setting in your session, you can use

enable_rdocs() # executed when you load RDocumentation
disable_rdocs()

Features:

  • Search through all CRAN, Bioconductor, Github packages and their archives thanks to RDocumentation.

  • Browse beautifully formatted and designed help pages.

  • Check if you have the latest version of a package and install or update with a single click.

screen shot 2016-08-11 at 16 23 58 screen shot 2016-08-11 at 16 25 59 screen shot 2016-08-11 at 16 24 55

  • Run examples with a single click; no more copy/pasting

Run examples

  • Post reviews and help package authors to improve their documentation