Improved documentation for R packages related to TAF

ices-eg / wg_WGTAFGOV

Working group on TAF Governance

https://community.ices.dk/ExpertGroups/WGTAFGOV/SitePages/HomePage.aspx

0 stars 1 forks source link

Improved documentation for R packages related to TAF #58

Open colinpmillar opened 2 years ago

colinpmillar commented 2 years ago

[ ] Provide a list of packages and state of documentation
[ ] List the downloads / usage of each package
[ ] Priorotise which packages need improved documentation

Levels of documention: High - CRAN + README.Rmd Medium - nonCran +minimal function definitions + README.Rmd Low - nonCran +minimal function definitions

nilsolav commented 2 years ago

By nest tafgov meeting Cecilia and Colin will make a more specific plan for this. We decided that the detailed descriptions should in general go to the wikipage. By nest tafgov meeting Cecilia and Colin will make a more specific plan for this.

colinpmillar commented 2 years ago

Related to this was a push for publishing several ices R packages on CRAN: this page has been populated https://ices-tools-prod.r-universe.dev/ui#builds

And the following packages have had thier documentation improved and accepted for publication on CRAN

icesDATSU
icesDATSUQC
TAF
rct3
icesConnect

colinpmillar commented 2 years ago

A follow up task is to list all the ices R packages and make a note of the state of the documentation available, e.g.

function documentation
Readme.Rmd with worked examples

Then we will list these on the page of R packages linked to from the TAF landing page