The web application running rdocumentation.org.
JavaScript CSS HTML Shell
Latest commit 34d9098 Dec 7, 2016 @ludov04 ludov04 tweak memory release
Permalink
Failed to load latest commit information.
.ebextensions force https Sep 21, 2016
api increase worker concurrency for computing direct/indirect stats Oct 27, 2016
assets comment Nov 3, 2016
config update worker to update percentile Oct 27, 2016
jake Fix date parsing from DESCRIPTION file Sep 20, 2016
migrations percentiles are now stored in the DB Aug 30, 2016
proxy/conf.d fix cors Oct 19, 2016
tasks fix linker Jun 30, 2016
views Set up Segment Nov 7, 2016
.dockerignore dockerfile for dockerhub.datacamp Jun 29, 2016
.editorconfig init sails project May 25, 2016
.gitignore reverse proxy Jun 30, 2016
.sailsrc disable socket io Jun 14, 2016
CONTRIBUTING.md Create CONTRIBUTING.md Sep 21, 2016
Dockerfile auto-migration for worker Jul 8, 2016
Dockerrun.aws.json.in force https Sep 21, 2016
Gruntfile.js init sails project May 25, 2016
LICENSE.md add License Jun 20, 2016
Procfile update Procfile Jul 29, 2016
README.md Update Readme.Md Aug 25, 2016
apidoc.json fix apidoc url Aug 25, 2016
app.js
build.sh worker deployment script Jul 5, 2016
cron.yaml update worker to update percentile Oct 27, 2016
database.json auto-migration for worker Jul 8, 2016
deploy_worker.sh take commit hash as version for deploying worker Jul 14, 2016
docker-compose.yml don't mount node_modules/ Jul 22, 2016
newrelic.js Distinguish new relic app for staging and prod Jun 28, 2016
package.json remove nodalytics from package.json Sep 1, 2016
pm2.json tweak memory release Dec 7, 2016

README.md

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).