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

add guidance for study description (no links) #1529

Open
1 of 6 tasks
Tracked by #161
mslarae13 opened this issue Aug 29, 2024 · 4 comments · May be fixed by #1528
Open
1 of 6 tasks
Tracked by #161

add guidance for study description (no links) #1529

mslarae13 opened this issue Aug 29, 2024 · 4 comments · May be fixed by #1528
Assignees

Comments

@mslarae13
Copy link

mslarae13 commented Aug 29, 2024

I can't remember if (no links) meant there wasn't a link... or we should remove the link..

But there is a link.

Do we have any written guidance or documentation on what a study description should be composed of?
Should we just pick a study with a good description and point people to it?

Suggestions:

Completion criteria:

  • Decide what we want the link to go to (study example or documentation)
  • Update "Provide a description of your study. This should include some general context of your research goals and study design. For examples, please see existing study landing pages on the data portal." to something else on the submission portal.
@mslarae13
Copy link
Author

Looking back, I think "Provide a description of your study. This should include some general context of your research goals and study design. For examples, please see existing study landing pages on the data portal." is good.

But maybe we should update/expand on the documenation and link to that too

Step 1 : Update documentation microbiomedata/docs#19
Step 2: update

studyDescription: 'Provide a description of your study. This should include some general context of your research goals and study design. For examples, please see existing study landing pages on <a href="http://data.microbiomedata.org" target="_blank" rel="noopener noreferrer">the data portal</a>.',
to

"Provide a description of your study. This should include some general context of your research goals and study design. For examples, please see existing study landing pages on the data portal. For more information, please see our written documentation."

@mslarae13
Copy link
Author

mslarae13 commented Jan 3, 2025

Step 1:
want to wait for microbiomedata/docs#125 to be merged in....

This is my recommended change:

### Study Name
The Study Information page requires a valid ‘Study Name’. We recommend the use of standardized, informative study names as described by the GOLD team (Mukherjee et. al., 2023). 

### Principle Investigator 
The Principle Investigator's email is required for submission. The Principle Investigator's email and name should also be provided. The submitter does not have to be the Principle Investigator.

### Webpage Links
Optionally, institute, project, or research lab weblinks can be provided. If your research group or program has a website to share, please include the links.

### Study Description
The `Study Description` should provide a summary that includes the context of your study, research, goals, and design. We recommend this be similar to abstract format, describing the entire study similar to how an abstract describes a single publication.

### Option Notes
Any additional information that is of value to your study can be provided here.

### Funding Source
The `Funding Source` of the research performed under this study should be provided and include an awarding program and the award or grant number. See an [existing study](https://data.microbiomedata.org/details/study/nmdc:sty-11-8fb6t785) for an example.  

### Contributors
The submitter can include ‘Contributors’ to acknowledge members of a research team associated with the study. This includes listing Contributor names, ORCiDs, and associating role(s) based on the CRediT (Contributor Roles Taxonomy). A Contributor can have a single or multiple roles. Additionally, if ORCIDs are provided, contributors can be assigned "Permission Level". This provides those listed with access to the submission based on the assigned permission level:
- Editor: Has permission to edit the entire submission & all its contents, with the exception of the `Contributors' section.
- Viewer: Has permission to see the entire submission, but cannot edit any piece
- Metadata Contributor: Has permission to edit the metadata portion of the submission, only. This permission level cannot edit "Submission Context", "Study Information", "Multi-Omics Data", or "Environmental Extension".

The submitter and PI are assigned "Owner" permission levels by default, that is that they have permission to edit the entire submission and all its contents, including the `Contributors` section.

@mslarae13
Copy link
Author

Contributors is already available via the ?

@mslarae13
Copy link
Author

#1528

@mslarae13 mslarae13 transferred this issue from microbiomedata/submission-schema Jan 29, 2025
@mslarae13 mslarae13 linked a pull request Jan 29, 2025 that will close this issue
@mslarae13 mslarae13 moved this from 🏗 In Progress to 👀 In Review in Submission Portal Tracking Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In progress
Status: 👀 In Review
Development

Successfully merging a pull request may close this issue.

1 participant