ncss-tech / soilDB

soilDB: Simplified Access to National Cooperative Soil Survey Databases
http://ncss-tech.github.io/soilDB/
79 stars 19 forks source link

soilDB vignettes / bookdown chapters #157

Open brownag opened 3 years ago

brownag commented 3 years ago

General TODOs suggested in #124

I think a good goal for soilDB in 2021 is to target creation of three or four different vignettes (long-form documentation) or bookdown "chapters".

These can be linked to relevant helpfiles for methods, allowing for more concise help but also more complete examples.

This will be a good exercise for all contributors and future contributors, as we focus our interfaces and work to provide even more comprehensive and generic coverage in a future soilDB 3.0.

Some ideas might be better as "vignettes" -- more document/tutorial like -- others could be more open-ended challenge exercises (with something resembling a "right answer" at least for the supplied example data)

brownag commented 3 years ago

These are some links to tutorials and demos gleaned from the soilDB docs whilst doing updates to \href syntax for .Rd to Roxygen conversion. Seems like as good of a place as any to keep these links for now.

I would like to collate them into some sort of grouping so we can relatively quickly run them all with the latest package versions, and use them as extended "tests" of more typical use cases than we do with {testthat}.

Initally a list of paths to .Rmds in the ncss-tech.github.io repo and a few calls to render() would do the trick.

brownag commented 1 year ago

A reminder to create at least one get_SDA*() function specific vignette and link to it from the new WCS vignette #290