R-Universe Documentation

Welcome!

R-universe is rOpenSci’s platform for improving publication and discovery of research software in R.

R-universe allows users and developers of R packages to…

  • Discover: R-universe provides a searchable catalogue for R software, articles, datasets, anywhere in the ecosystem. That catalogue is indexed and ranked using R specific features.

  • Learn: R-universe serves rendered material and extensive background information to learn about a package and get started using it.

  • Publish: R-universe is an open platform for running personal cran-like package repositories to make your work visible and accessible to a big audience, with or without CRAN.

  • Develop: R-universe provides a zero config development environment for continuous integration (identify upcoming breakage before the release), experimental R features, new platforms such as WebAssembly, etc.

Find out more context, and recent videos, on the project page on the rOpenSci website.

Using this guide

Are you…

  • An R user that just wants to search something or retrieve information;
  • A package developer;
  • A universe developer (aka r-multiverse /pharmaverse /biocondctor or similar people);
  • Someone willing to contribute to r-universe to improve the infrastructure or documentation?

This documentation should help. Use the table of contents on the left, and please contribute (next section) if anything is unclear or missing!

Contributing to this guide

We welcome contributions to this guide.

  • For small changes, please open a pull request.
  • To suggest larger changes, open an issue. We may invite you to create the changes or implement them on your behalf.

Make sure to read our contributing guide before getting started.

Acknowledgements and licence

We’re grateful for reviewers of this documentation website:

This website is licensed under the CC BY-NC-ND 4.0 License.