lcolladotor / biocthis

Automate package and project setup for Bioconductor packages
https://lcolladotor.github.io/biocthis/
50 stars 17 forks source link

More in depth guide for the /dev scripts for making new R/Bioconductor packages #45

Open lcolladotor opened 11 months ago

lcolladotor commented 11 months ago

While the scripts in /dev are useful for people interested in making a new package, the code comments are not the most comprehensive. To compliment these scripts, we plan to create a more in depth guide (vignette) which is linked to from the /dev scripts. There we will be able to explain caveats, background, and things to be aware of.

The goal is not to reproduce https://contributions.bioconductor.org/develop-overview.html. The goal is to explain each of the functions used and have a single place for documenting them instead of referring users to different help pages / guides (vignettes) where they can get lost in all the information.

Right now the /dev scripts are useful, but feel a bit like a black box for new users based on my impression from short courses using these scripts.