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

Suggestions to make metrics more searchable #52

Open
michaeldumelle opened this issue Nov 6, 2024 · 0 comments
Open

Suggestions to make metrics more searchable #52

michaeldumelle opened this issue Nov 6, 2024 · 0 comments

Comments

@michaeldumelle
Copy link

michaeldumelle commented Nov 6, 2024

It would be really helpful to include some helper functions that make metrics more searchable and usable within R. There are so many metrics at different scales (which is amazing!) that it can be overwhelming to find what is needed. Something like:

sc_get_metric_names(
    type = "climate",
    aoi = "watershed",
    source = "StreamCat",
    year = NULL,
    ....
)
  • type : different "types" of variables (e.g., climate, geologic, anthropogenic, other, etc.)
  • aoi: area of interest (catchment, watershed, etc)
  • source: source, either StreamCat or NLCD
  • year: year, relevant if source = "NLCD"
  • ...: Other arugments if relevant like state, region, etc.

Output could be a data frame (or tibble) and look something like:

    name        metric       aoi    source     type
1 name-1   temperature watershed StreamCat  climate
2 name-2 precipitation watershed StreamCat  climate

Vector arguments could be applied to the function, yielding something like

sc_get_metric_names(
    type = c("climate", "geologic"),
    aoi = c("watershed", "catchment"),
    source = "StreamCat",
    year = NULL,
    ....
)
    name        metric       aoi    source     type
1 name-1   temperature watershed StreamCat  climate
2 name-2 precipitation watershed StreamCat  climate
3 name-3   temperature catchment StreamCat  climate
4 name-4 precipitation catchment StreamCat  climate
5 name-5 calcium_oxide watershed StreamCat geologic
6 name-6 calcium_oxide catchment StreamCat geologic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant