RDocumentation v0.8.2

0

Monthly downloads

0th

Percentile

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.

Readme

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)

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

Functions in RDocumentation

Name Description
RDocumentation-package Integrate R with RDocumentation.org
check_package Check if a package is installed for the user.
documentation Documentation on RDocumentation or via the normal help system if offline
hideViewer Redirects the viewer to the RDocumentation help page.
No Results!

Last month downloads

Details

Type Package
URL https://www.rdocumentation.org, https://www.datacamp.com
BugReports https://github.com/datacamp/RDocumentation/issues
License GPL (>= 2)
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2018-01-23 08:53:38 UTC; ludov
Repository CRAN
Date/Publication 2018-01-23 22:30:32 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/RDocumentation)](http://www.rdocumentation.org/packages/RDocumentation)