Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datacamp/rdocumentation-2.0
📚 RDocumentation provides an easy way to search the documentation for every version of every R package on CRAN and Bioconductor.
https://github.com/datacamp/rdocumentation-2.0
bioconductor cran documentation packages rstats
Last synced: 3 days ago
JSON representation
📚 RDocumentation provides an easy way to search the documentation for every version of every R package on CRAN and Bioconductor.
- Host: GitHub
- URL: https://github.com/datacamp/rdocumentation-2.0
- Owner: datacamp
- License: mit
- Created: 2020-11-25T19:30:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T08:55:44.000Z (3 months ago)
- Last Synced: 2024-12-03T16:04:22.192Z (10 days ago)
- Topics: bioconductor, cran, documentation, packages, rstats
- Language: TypeScript
- Homepage: https://rdocumentation.org
- Size: 720 KB
- Stars: 286
- Watchers: 20
- Forks: 44
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - datacamp/rdocumentation-2.0 - 📚 RDocumentation provides an easy way to search the documentation for every version of every R package on CRAN and Bioconductor. (TypeScript)
README
# RDocumentation 2.0
_Note:_ Please read this [confluence page](https://datacamp.atlassian.net/wiki/spaces/PRODENG/pages/2314469377/RDocumentation) which explains the architecture of how RDocumentation works, and how to run the backend locally.
Available at:
Internally:
RDocumentation provides an easy way to search the documentation for every version of every R package on [CRAN](https://cran.r-project.org/) and [Bioconductor](http://bioconductor.org/).
## Setup
To run locally, clone this repo and `cd` into the directory.
Create a `.env.local` file at the root of the repository. Since RDocumentation fetches data from the GitHub API, you'll need to create a GitHub [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) (with `public_repo` scope) and add it as an environment variable.
```
GITHUB_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN
```
Then run the following to install dependencies and start the development server on `http://localhost:3000`:
```
nvm use
yarn
yarn dev
```
## Contributing
We welcome all sorts of contributions, be it new features, bug fixes or documentation, we encourage you to create a new PR. To create a new PR or to report new bugs, please read how to [contribute to RDocumentation](./CONTRIBUTING.md).
## Stack
This website was built by [Nick Carchedi](https://nickcarchedi.com/) using [Next.js](https://nextjs.org/), [Tailwind CSS](https://tailwindcss.com/) and DataCamp's own [Waffles component library](https://waffles.datacamp.com/component-library). We ❤️ open source.