search

tobyjohnson / gtx

Genetics ToolboX R package
30 stars 9 forks source link

documentation may be generated automatically with roxygen2/document() #41

Open dalloliogm opened 6 years ago

dalloliogm commented 6 years ago

Documentation may be generated automatically using devtools:document and the roxygen2 syntax.

For example, see here: http://kbroman.org/pkg_primer/pages/docs.html

Ksieber commented 6 years ago

I have used roxygen2 once before for PICCOLO and I liked it a lot. Do you have a lot of experience using it @dalloliogm ?

dalloliogm commented 6 years ago

Hi Karsten! I try to use it for my scripts, at least when I remember to add documentation :-). I think it works very well, the syntax is easy and it allows to have documentation and code in the same file.