Adding Roxygen comments to RCy3.R to give package help documentation?

tmuetze / Bioconductor_RCy3_the_new_RCytoscape

Update RCytoscape to work for Cytoscape 3.0 and higher using CyREST

16 stars 10 forks source link

Adding Roxygen comments to RCy3.R to give package help documentation? #24

Closed jooolia closed 8 years ago

jooolia commented 8 years ago

Would it be ok to add roxygen comments to RCy3.R with the goal of automatically generating a help page for RCy3 with devtools? Currently help(RCy3) and ??RCy3 contain no documentation. The other option would be to manually make a .Rd file. I am happy to contribute either or something else that is thought to work best with the package.

tmuetze commented 8 years ago

Absolutely!