Can you point me to really well written R/Python package documentation?

1

Can anyone point to really well written (R/Python) documentation that it could almost be a software paper in the current state. Links to vignettes (or similar) would be super helpful. A long form vignette that goes beyond simple description of package functions but also covers a few use cases and scientific applications is what I am looking for.

TIA

2

David Winter wrote some great vignettes for the rotl package that show how to use the package to answer real scientific questions:

3

The vegan vignettes are really good.

4

My package ddpcr has a README and two vignettes (1, 2) that are going to be copy-pasted into my thesis, might be what you’re looking for

1 Like
5

We based our codyn paper submission directly off of our vignettes. Might be
of interest to you.

Matt

6

link to the paper matt?

7

Perfect, thanks Dean! Exactly what I was aiming for.

8

@sckott here: https://github.com/laurenmh/codyn/tree/master/vignettes

9

Thanks @francois_michonneau!

10

I’m late to the party, but I think the MARSS (for R) vignettes are pretty good. The User’s Guide has some background info plus lots of applications.

https://cran.r-project.org/web/packages/MARSS/index.html

11

@karthik I’m also a bit late to this, but I think DiagrammeR has very well written software documentation: http://rich-iannone.github.io/DiagrammeR/docs.html