EDIorg / EMLassemblyline

R package for creating EML metadata
https://ediorg.github.io/EMLassemblyline/
MIT License
28 stars 13 forks source link

Unspecifiable EDI metadata field: "methods" #123

Open vlahm opened 1 year ago

vlahm commented 1 year ago

There is a "Methods" field under Table Column Descriptions on the EDI portal (see screenshot below), but I can't see how to populate it using EAL tools (or ezEML for that matter). The help files for template_table_attributes don't mention any such field.

I realize not everything is within scope for this package, but I'm wondering if someone could instruct me on how to specify the EML tag that would allow me to populate this field.

image

cgries commented 1 year ago

HI Mike, this is not available in either EAL or ezEML because we highly discourage the use of it. It is more re-user friendly to put all methods into the one main methods field. We find it hard enough to get re-users to read the one methods field and the ramifications for reuse. If you really need that field you would have to manually add it in an XML editor (e.g.) Oxygen or plain text editor. Please keep in mind, that no matter where you put the methods description, it will mostly be human readable not so much machine interpretable in the foreseeable future.

vlahm commented 1 year ago

Oh, hi Corinna! Thanks, this makes sense. I planned to leverage the power of the categorical attribute metadata after we spoke, but realized that doesn't work in my case: the categories are among columns, rather than rows.

I now plan to direct users to a secondary table (a subset of this) where source, category, and methods information for collections of attributes will be stored. Still, there are a few attribute-specific details that just don't fit well anywhere, and would only be relevant to people who are hunting for them. I'll put such details in the attribute methods and use the attribute definition to direct people to these other locations.

It looks like I just need a <methodStep> tag inside a <methods> tag, and <description> makes it prettier.