Integrate R with 'RDocumentation'

Wraps around the default help functionality in R. Instead of plain documentation files, documentation will show up as it does on < https://www.rdocumentation.org>, a platform that shows R documentation from 'CRAN', 'GitHub' and 'Bioconductor', together with informative stats to assess the package quality.


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.

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)

If the package is loaded, it 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.

Features:

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

  • Browse beautifully formatted and designed help pages.

  • Post reviews and help package authors to improve their documentation

News

RDocumentation 0.8.2

  • Fix violation of cran policy, cutted down functionalities

RDocumentation 0.8.1

  • Fix violation of cran policy
  • Various bugfixes

RDocumentation 0.8.0

  • Bugfixes

RDocumentation 0.7.1

  • Less invasive overrides

  • Remove https from viewer pane for RStudio Windows users

  • Now works on RStudio Server and standalone R

RDocumentation 0.7.0

  • Numerous bug fixes

  • Option to disable/enable autoload the package at startup

  • Option to disable/enable overriding of defaults help functions (?, help, help.search(...))

  • Changed version number to semver

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("RDocumentation")

0.8.2 by Ludovic Vannoorenberghe, 2 years ago


https://www.rdocumentation.org, https://www.datacamp.com


Report a bug at https://github.com/datacamp/RDocumentation/issues


Browse source code at https://github.com/cran/RDocumentation


Authors: Ludovic Vannoorenberghe [cre] , Jonathan Cornelissen [aut] , Hannes Buseyne [ctb] , Filip Schouwenaars [ctb]


Documentation:   PDF Manual  


GPL (>= 2) license


Imports httr, proto, rjson, utils

Suggests testthat


See at CRAN