NFDI4Microbiota / NFDI4Microbiota/MetadataStandards

Suggestion, Standardizing the features name of the minimal metadata standards

Open
#12 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
10
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Dear All,

I have a concern about the column name of the metadata.
I believe it would be better for the column name to be underlying a simple and predictable pattern.
for example, in sections "2.2 Amplicon sequencing." and "2.8 Metabolomics."
we have different patterns:

  • sample_name: two sections, using a hyphen, using the complete world.
  • seq_meth: two sections, using a hyphen, using abbreviation instead of complete words (seq instead of the sequence, meth instead of method).
  • sequence_count_qual: three sections, using two hyphens, a mixture of complete and abbreviate (sequence and count are complete words, qual is abbreviation quality).
  • LSU_recover: two sections, using a hyphen, the mixture of lower and upper case letters
  • Sample species: two sections, using white space, camel case.
  • Project title versus sample_name: both refer to identity, but the names include ambiguity.

In my mind, this naming can cause some mistakes automatically, So I suggest we use a predictable pattern for all names in all sections. Here is put some suggestions about naming.

  • Using lowercase in all names: sample_scpecies instead of Sample species
  • Using the full name instead of abbreviation: 'sequence_method' instead of seq_meth in all names
  • Separating words: prevent different strategies for separating words, using hyphens instead of the dash and space.
  • Using similar names for columns with the same nature: sample_identity and project_indentity instead of sample_name and project_title.

These notes are just suggestions, and we can discuss that to make a comprehensive standard for defining the name of features of the metadata.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the metadata naming in sections 2.2, “Amplicon sequencing,” and 2.8, “Metabolomics,” then inventory the differing column-name patterns described in the issue. The work is complete when a documented naming convention is agreed and applied consistently across the relevant sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.