waldronlab / BugSigDBcuration

For documenting issues related to BugSigDB curation.
10 stars 7 forks source link

Welcome Outreachy Applicants! #94

Open cmirzayi opened 1 year ago

cmirzayi commented 1 year ago

Welcome Outreachy Applicants!

Note: This task can be completed by multiple Outreachy applicants.

BugSigDB Project

BugSigDB is a wiki built to capture standardized microbial signatures of health outcomes and enables the systematic comparison and synthesis of published human microbiome studies, https://bugsigdb.org/Main_Page. As context, the human microbiome is the collection of microorganisms colonizing the human body. It performs essential functions such as producing vitamins and important nutrients, metabolizing food and drugs and toxins, regulating epithelial development, and influencing innate immunity. It is modified by diet, medical treatment, and host-to-host transmission, and can be a mediator between environment and health. The main result of most published human microbiome studies are lists or “signatures” of differentially abundant microbial taxa in different groups, which are often classified by health condition, behavior or risk factor. A microbial signature is a list of bacteria, viruses, and/or archaea reported to be differentially abundant with respect to health outcomes (e.g., cancer, diabetes, obesity) or with respect to sociodemographic characteristics (e.g., age, smoking, income, or place of residence). These signatures are often reported in heterogeneous ways with different taxonomic nomenclature databases and do not allow direct comparison of methods or results in different studies. BugSigDB contributors aim to create a comprehensive coverage of the human microbiome literature that allows for (1) comparisons between new research findings and previously published results in any area of the health literature and (2) identification of common patterns of differentially abundant microbes across otherwise disparate health outcomes.

Prep Work

To make a contribution to the BugSigDB project, applicants should first review the onboarding materials: BugSigDB project information, estimated time: 15 minutes (link) Reading materials on the human microbiome, estimated time: 2 hours (link) Step-by-step guidance on how to document a signature in BugSigDB (link) View examples of completed BugSigDB curations, estimated time: 15 minutes (link) Video trainings on BugSigDB curation (link)

First Contribution Task

  1. Go to the first curation form
  2. Review the article on the human microbiome that has been heavily annotated by BugSigDB project leaders (e.g., explaining the section(s) of the article that convey study design and the specific characteristics that determine study design)
  3. Complete a mini-curation, akin to BugSigDB curations, on Qualtrics XM.

Link to curation form: https://cunysph.az1.qualtrics.com/jfe/form/SV_1RfUgk72TYmcBHE

Please submit a fully completed mini-curation via the form above before continuing to the second contribution task.

Second Contribution Task (Optional)

As an optional, higher-difficulty-level task, you may claim an article on the human microbiome from the BugSigDBcuration GitHub issues tagged "paper to curate" and work on a full curation.

To claim an article for curation, post a response to the issue with your name and we will mark it as claimed. Please only claim one article for curation until you have completed this curation and it has been graded.

To curate the article you select, first create a BugSigDB account (https://bugsigdb.org/Special:RequestAccount) and follow the website prompts to complete the curation.

Assessment & Grading

Your first contribution will be scored for accuracy. Your second contribution will be scored with the following rubric:

  1. All elements marked "Needs review" (none "Incomplete") (1 point):
  2. Correct study design (1 point):
  3. Entered all relevant experiments and no irrelevant experiments (1 point):
  4. Body site correctly identified (i.e. does not include multiple sites) (1 point):
  5. Condition entered according to contrast (correct EFO ontology) (1 point):
  6. Contrast groups correctly identified (1 point):
  7. Groups correctly labeled as 1 and 0 (1=cases, 0=controls) (1 point):
  8. Antibiotic exclusion correctly identified (1 point):
  9. Correctly identified sequencing details (1 point for sequencing type and variable region, 1 point for sequencing platform) (2 points):
  10. Identified correct statistical test (1 point):
  11. Identified MHT correction (1 point):
  12. Correctly recorded matched on variables (1 point):
  13. Entered correct number of statistical tests per experiment (1 point):
  14. All diversity measures identified (1 point):
  15. Diversity results correctly entered as increased/ decreased/ unchanged (1 point):
  16. All signature sources correctly identified (-1 for each error) (2 points):
  17. Abundance direction correctly selected (1 point):
  18. Members of signatures identified correctly (1 point for single small error, 0 points for anything more. Incorrect means missing or extraneous taxon) (2 points):
  19. Correct use of NCBI taxonomy (don't deduct if can't easily find correct taxon in NCBI taxonomy database. 1 for one error, 0 for multiple errors) (2 points):

Total (maximum 23 points):

Please note it may take us several days to score your second contribution, depending on how many contributions we receive. Once scored, you will have the opportunity to revise your curation to remedy any identified errors; however, we will record both your original and revised score when evaluating your second contribution. We strongly recommend you ask questions on our Slack channel, compare your curation to completed curations on BugSigDB, and attend office hours prior to submitting your second contribution for grading.

Questions

Communication regarding specific tasks should be done on a task's GitHub issue or on the Bioconductor Slack channel #bugsigdb, which is monitored by mentors and other project participants who can help you. Sign up for an account at https://slack.bioconductor.org/. After you log in, join the channel #bugsigdb.

To reduce duplicate questions, please do not directly message or email the BugSigDB mentors.

Office Hours

Office hours will be held at 9 AM EDT (eastern daylight time) every Thursday. Attendance by all applicants is highly encouraged. More details here https://github.com/waldronlab/BugSigDBcuration/issues/95

Contributions

Remember to record your contributions in Outreachy.

Analyst-Joan commented 1 year ago

@cmirzayi I have submitted a fully completed mini-curation for issue #94 first contribution task via the form link provided.

However, I noticed the link to record contributions in Outreachy needs to be updated from https://www.outreachy.org/outreachy-may-2023-internship-cohort/communities/bioconductor/#microbiome-study-curation which is for May-2023 cohort to https://www.outreachy.org/outreachy-december-2023-internship-round/communities/bioconductor/microbiome-study-curation for December-2023 cohort, as the current one does not redirect to the right page. It shows image below

image

Thanks.

cmirzayi commented 1 year ago

@Analyst-Joan Nice catch. Thank you. I've updated it.

Win13nie commented 1 year ago

Hello @cmirzayi I have submitted a fully completed mini curation/first contribution via a form link provided.

Chloebea commented 1 year ago

hello @cmirzayi @lwaldron it has come to my notice that on the welcome outreachy applicants page on github has the link to record contribution as https://www.outreachy.org/outreachy-december-2023-internship-round/communities/bioconductor/microbiome-study-curation/ which re-directs to a page that says "page not found" as shown below. WhatsApp Image 2023-10-18 at 11 20 56 PM WhatsApp Image 2023-10-18 at 11 20 56 PM (1)

i suggest that the link is changed to https://www.outreachy.org/outreachy-december-2023-internship-round/communities/bioconductor/microbiome-study-curation/contributions/

thank you.

cmirzayi commented 1 year ago

@Chloebea Thanks. It has been fixed.

Chloebea commented 1 year ago

@cmirzayi do I record what i have suggested here as a contribution too.. ??

PATIENCE-ONAH commented 1 year ago

Hello @cmirzayi, I have been browsing through the paper to curate for my second contribution but unable to find any that have not been assigned. Please kindly support me with a paper to work on.

LiliGC commented 1 year ago

Hello @cmirzayi I have completed mini curation/first contribution via a form link provided and an account request to BugSigDB.

Elsie-ND commented 8 months ago

Hello, I have completed the mini-curation task for the first contribution via the link provided.

FlourishRalph commented 8 months ago

Hello @cmirzayi I have completed my first contribution task using the form link provided.

enejepromise commented 8 months ago

Hello, @cmirzayi. I have been able to complete my first task, I have not been assigned to any paper to work on. kindly support me with a paper to work on.

mariam665 commented 8 months ago

Hello @cmirzayi, I just completed my first task.

Somali10 commented 1 month ago

Hi @cmirzayi I finished the required one https://cunysph.az1.qualtrics.com/jfe/form/SV_1RfUgk72TYmcBHE https://github.com/waldronlab/BugSigDBcuration/issues/94

https://github.com/waldronlab/BugSigDBcuration/issues/94

https://cunysph.az1.qualtrics.com/jfe/form/SV_1RfUgk72TYmcBHE

Somali10 commented 1 month ago

Finished Second contribution https://bugsigdb.org/Study_775