Helpr is an R package that betters friendly HTML documentation. With links to other packages, function aliases, and function sources, finding information is a click away. Using the comprehensive search bar, searching across all R packages is quick and effortless.
The heart of helpr
is hosted locally. No internet is required to display all of the documentation, while functionality of the search bar, RSS feed, and comment system requires an internet connection.
The development of helpr
was made possible with generous support from Revolution Analytics.
Allows you to update out-of-date packages
Package Page
Disqus comment system
Topic Page
Disqus comment system
Source Page
Disqus comment system
Demo Page
To install helpr
, you first need to install some packages:
install.packages( c("stringr", "digest", "mutatr", "brew", "testthat") )
http://github.com/hadley/sinartra
Running from an installed package:
library(helpr)
helpr()
Running the development version:
# With working directory set to the helpr package directory
library(devtools)
load_all("helpr")
helpr()
Follow the tutorial to get a feel how it works.
(Developers) To install solr
, you first need to install brew
ruby -e "$(curl -fsS http://gist.github.com/raw/323731/install_homebrew.rb)"
install solr with brew: brew install solr
Add/replace the two files in solr-conf to solr's example/solr/conf folder
java -jar start.jar
in the /example solr directory to start the server/usr/local/Cellar/solr/1.4.0/
To add/update files, execute one of the index commands from R
index_topic(package, topic)
index_package(package)
index_all()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.