dankelley
commented
2 years ago This wiki page has material that could maybe go in the docs for dod.ctd(), or in a vignette. I prefer a vignette, because if a doc gets too long, folks will get lost in it.
I think ?dod.ctd should give just a brief sketch, explaining parameters, etc. Our table does that.
A vignette has the space for maybe a page or so on each program. It could show a worked example, maybe even a plot. A vignette can have a table of contents, making it easy for folks to find things. It can have any content we want (within size limits and download-time limits). One nice thing is to have exercises for the reader, with solutions at the end (like in the oce vignette at https://cran.r-project.org/web/packages/oce/vignettes/A_oce.html)
@AnnieHow I think it would be good to add
dod.ctd(program="ITP")to get ice-tethered profilers, which are great for Arctic data. This is not a stop-other-work sort of idea, just something that might be nice to get over the next few weeks or so.I've put some notes about the ITP program, with links that might be used in
dod.ctd(), at the wiki pagehttps://github.com/AnnieHow/dod/wiki/dod.ctd(program=%22ITP%22)
PS. I also put wiki stubs for the other two CTD things we have. I think those wiki pages might be a good way to document where data are. I find it a bit hard to make sense of issues, which are more like diaries than coherent essays.