rOpenSci's guide for packages in our suite. Read it here.
This book contains our guidelines for packages contributed to the rOpenSci suite of packages. They are always a work in progress - corrections, suggestions and general improvements are welcome as issue submissions in this repository. Open discussions are welcome in our forum. You can also suggest changes by editing the .Rmd files that are at the root of this repository and submitting a pull request. An "edit" button at the top of all book chapters will take you directly to the relevant page on GitHub to make such changes. Please target your pull requests to the dev branch.
Deployment is done via Travis CI using the rOpenSci tic and travis packages:
-
whenever there's a push to
master, the book is built on Travis to a_bookfolder whose content is then pushed from Travis to thegh-pagesbranch. -
whenever there's a push to
dev, the book is built on Travis to a_bookfolder whose content is then pushed from Travis to thedev-sitebranch that gets deployed to Netlify.
We copied this setup from Data Carpentry.
If you're an associate editor, you can also push directly to master for small fixes. We shall use PRs to dev for discussing larger updates, and PR from dev to master for each release.
If you're an associate editor and you want to render the book locally you need to install bookdown and the other dependencies stated in DESCRIPTION in particular use devtools::install_github("bergant/airtabler"), and get and store an Airtable API key following their instructions (if you're not an editor, you don't have access to our Airtable base). Then use bookdown::render_book('index.Rmd', 'bookdown::gitbook') and the book will be generated in the _book folder; you can open the book on the command line by doing open _book/index.html.
This book was started using Sean Kross' minimal bookdown example.
All of the content of this repository is licensed CC-BY-SA.