/rdocumentation-app

The web application running rdocumentation.org.

Primary LanguageJavaScriptMIT LicenseMIT

rdocumentation_site_banner

The web application running rdocumentation.org.

rdocumentation.org aims at providing the R community with centralized, quality and easy to search documentation.

R documentation update hourly all his CRAN, Github and Bioconductor packages. All the Rd files are parsed and indexed in a elasticsearch database. This makes rdocumentation.org the best online resource to browse the documentation of R packages.

Features

  • Quick search through all packages and functions screen shot 2016-08-25 at 14 07 05

  • Complete search through all packages and function screen shot 2016-08-25 at 14 08 52

  • Easily assess package quality

    screen shot 2016-08-25 at 14 11 27

  • Run examples inside your browser thanks to https://github.com/datacamp/datacamp-light screen shot 2016-08-25 at 14 13 29

  • Post community examples to help the community understand how to use a function screen shot 2016-08-25 at 14 14 37

API

DataCamp encourages the reuse of the data from rdocumentation.org, a public API is available. More info at http://www.rdocumentation.org/docs/

Issue/Feature request

Please post a new issue at https://github.com/datacamp/rdocumentation-app/issues for any bug that you encounter or a feature that you would like to see in rdocumetation.org

Development

Using docker

  • Install the docker toolbox
  • docker-compose build to build your local docker image
  • Execute docker-compose run server npm install --no-bin-links to install npm dependencies.
  • Run the database migrations by doing docker-compose run server node node_modules/db-migrate/bin/db-migrate up.
  • docker-compose up

Without docker

  • Install MySQL and Node.js on your system
  • Run npm install
  • Create an empty database rdocsv2
  • Execute the migrations: NODE_ENV=development node node_modules/db-migrate/bin/db-migrate up
  • node app.js (or if you have nodemon installed: nodemon app.js)

License

See the LICENSE file for license rights and limitations (MIT).