This shows you the differences between two versions of the page.
development:ohdsi_documentation_guidelines [2015/02/06 07:53] schuemie created |
development:ohdsi_documentation_guidelines [2015/02/06 07:53] (current) schuemie |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== OHDSI Documentation guidelines ====== | + | ====== OHDSI documentation guidelines ====== |
For R packages we use the standards for documenting those, so use in-line documentation (using Roxygen) to document functions which are collected in a package manual, and optionally vignettes (using KNITR) to describe how to use a package. | For R packages we use the standards for documenting those, so use in-line documentation (using Roxygen) to document functions which are collected in a package manual, and optionally vignettes (using KNITR) to describe how to use a package. | ||
For everything else we use the wiki. | For everything else we use the wiki. |