duplisea / gslea

Gulf of St Lawrence Ecosystem Approach
GNU General Public License v3.0
17 stars 1 forks source link

Recommendation: pkgdown website #5

Open andybeet opened 8 months ago

andybeet commented 8 months ago

Without meaning to overstep any boundaries, i think the pkgdown R package would really enhance the reach, useabililty, and readability of your package. pkgdown will convert all of your function and data documentation into a nice looking website, in addition to whole host of other things.

Currently there is a lot of content in the readme which could be relocated within the R package to be nicely converted into pages on a website.

You'd get:

You can build it all locally first to test it out before deploying it to gh-pages branch.

duplisea commented 7 months ago

Thanks Andy. I will check this out, it sounds great. I did not see your issue until now, sorry for the tardiness.

The ICES paper describing the package is now available:

https://academic.oup.com/icesjms/advance-article/doi/10.1093/icesjms/fsae024/7627832