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

Provide additional information for the terms used in the Data Manager #839

Open
1 task done
Shraddha0903 opened this issue Sep 25, 2024 · 3 comments
Open
1 task done
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request medium prio tasks that require intermediate attention triage An issue that is in discussion to be either scheduled for implepmentation or denied

Comments

@Shraddha0903
Copy link
Contributor

What are you missing?

Currently there is no information (definition or example) provided for the terms such as species, specimen, analyte, experimental variables and groups, biological replicates in the DM.
This additional information would help the user in filling out these terms with the correct data.

List of terms:

  1. Species
  2. Specimen
  3. Analyte
  4. Analysis to perform
  5. Experimental variables
  6. Experimental groups (esp. how to create groups)
  7. Biological replicates
  8. Technical replicates (after it's implemented)
  9. Project ID
  10. Objective
  11. Project Responsible

Would be also helpful to provide:

  1. What is an experiment?

Why do you need a solution?

The user finds the terms used in the Data Manager confusing and needs more information about what the term means in context with the Experiment and the Project.

Ideas

We can provide tooltips for these terms inside the Data Manager
Include definitions in the documentation
Provide a glossary of the terms in the application itself

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Shraddha0903 Shraddha0903 added enhancement New feature or request triage An issue that is in discussion to be either scheduled for implepmentation or denied labels Sep 25, 2024
Copy link

This issue is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale label Oct 29, 2024
Copy link

This issue was closed because it has been inactive for 14 days since being marked as stale.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Nov 29, 2024
@Steffengreiner Steffengreiner added documentation Improvements or additions to documentation medium prio tasks that require intermediate attention and removed stale labels Jan 16, 2025
@Steffengreiner
Copy link
Contributor

I think this is a great idea, Having a tooltip within the application and a glossary in the research data management documentation would help a lot for users to understand what is meant with each term

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request medium prio tasks that require intermediate attention triage An issue that is in discussion to be either scheduled for implepmentation or denied
Projects
Status: Approve
Status: Todo
Development

No branches or pull requests

3 participants