ropensci / EML

Ecological Metadata Language interface for R: synthesis and integration of heterogenous data
https://docs.ropensci.org/EML
Other
97 stars 33 forks source link

Revisit how users can find a learn to use the `eml$*` constructors #334

Open amoeba opened 2 years ago

amoeba commented 2 years ago

[I didn't find a ticket related to this but let me know if there is one]

You can create EML with this package using three modalities and those modalities can be mixed together:

  1. plain old lists
  2. set_* methods
  3. eml$* constructors

They all require you to know a decent amount of the EML standard to use and probably look things up as you work. However, sometimes I think you know what element you need but not what child elements it takes. This is where the eml$* constructors are useful.

That said, they're not well-documented. ?eml gives you a nearly blank help page and I'm not sure there's help elsewhere.

Could we make this situation better? I had a few ideas:

Please add in any ideas or ask questions.

mbjones commented 2 years ago

The discussion of auto-generated docs for eml$ is in https://github.com/ropensci/EML/issues/252#issuecomment-442595315

cboettig commented 2 years ago

yup, with prototype over at https://cboettig.github.io/build.eml/reference/eml.html, but still needs more test-driving to figure out what issues arise from this approach. (Some we've discussed in https://github.com/cboettig/build.eml/issues/2)