Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

soilDB vignettes / bookdown chapters #157

Open
brownag opened this issue Jan 16, 2021 · 2 comments
Open

soilDB vignettes / bookdown chapters #157

brownag opened this issue Jan 16, 2021 · 2 comments
Labels
good-first-issue A good issue for a new contributor! Try your best and make a pull request! (or issue/discussion!) help wanted
Milestone

Comments

@brownag
Copy link
Member

brownag commented Jan 16, 2021

General TODOs suggested in #124

  • inventory soilDB related tutorials, examples, etc.
  • organize soilDB content via bookdown or related system
  • provide links to extended examples in manual pages

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)

  • SDA Components -- Accessing SSURGO and STATSGO data from Soil Data Access

    • Prequel to "tabular aggregation" with some future aggregation-engine
  • SDA Spatial -- Points, polygons and bounding boxes from SSURGO, STATSGO, and survey area polygons fetched from Soil Data Access,

    • SDA_spatialQuery and fetchSDA_spatial.
  • Soil Survey Timelines -- A walk-through of @smroecker's soil survey area timeline, pedons over time, etc. graphs and datasets.

  • Web Coverage Service -- SoilWeb web coverage service (raster) demonstration ISSR800 and SSURGO MUKEY

  • SoilWeb "Series Concept" tools -- e.g. fetchOSD, seriesExtent

  • Thematic maps of soil taxonomic concepts with {soilDB} and {tmap} - @jskovlin

  • NASIS Pedons & NASIS Components -- two separate guides showing a "real" fetchNASIS dataset, with problems to solve; all reproducible because it will be a [reduced] SQLite source (2.6.x+); exercise objective is to create a variety of reports or output that show the errors (say, to hand off to some hypothetical person to fix)

  • Custom NASIS queries and NASIS automation with {soilDB}

  • {lattice} + {tactile} graphics demos, worked examples, templates, snippets and guidelines

@brownag brownag added good-first-issue A good issue for a new contributor! Try your best and make a pull request! (or issue/discussion!) help wanted labels Jan 16, 2021
@brownag
Copy link
Member Author

brownag commented Jan 29, 2021

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 brownag added this to the soilDB 3.0 milestone Jul 22, 2022
@brownag
Copy link
Member Author

brownag commented Jun 7, 2023

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

@brownag brownag mentioned this issue Jun 7, 2023
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue A good issue for a new contributor! Try your best and make a pull request! (or issue/discussion!) help wanted
Projects
None yet
Development

No branches or pull requests

1 participant