Closed carriewright11 closed 2 years ago
@stephaniehicks This has some typos and I want to rearrange things... but I think this is a good start. Also, want to make an open case study code of conduct like bioconductor but one that talks about case study specifics. I would love your thoughts about that!
this is now out of date - I have updated based on a meeting with stephanie hicks
General Information
Update the following URL to point to the GitHub repository of the case study repo you wish to submit to OpenCaseStudies:
Confirmations
Confirm the following by editing each check box to '[x]'
[ ] I understand that by submitting my case study to OpenCaseStudies, ownership of the case study repo will eventually need to be transferred to the OpenCaseStudies organization. All source and all review commentary will be made visible to the general public.
[ ] I am familiar with the Open Case Study code of conduct and agree to abide by it.
[ ] I have read the OpenCaseStudy Submission Guideline instructions. My package is consistent with the Bioconductor Submission Guidelines.
[ ] My case study uses only open source programming languages
[ ] My case study uses data that is publicly available
[ ] If I made the data available, I am allowed to do so
[ ] I provide transparent descriptions of the source of the data and how it was generated when possible
[ ] All general steps are described within the case study or included within click-to-expand sections
[ ] Attributions: all outside sources are referenced and cited appropriately -[ ] disclaimers are included -[ ] licences for use are included -[ ] All images/gif/videos andother forms of media that are not original to the case study include sources -[ ] Information on how to cite the case study is included
[ ] All Core sections of the case study are present or within another case study
[ ] Motivation
[ ] Main Question(s)
[ ] Learning Objectives
[ ] Context
[ ] Limitations
[ ] What are the data?
[ ] Data Import
[ ] Data Exploration and Wrangling
[ ] Data Visualization
[ ] Data Analysis
[ ] Summary
[ ] Suggested Homework
[ ] Additional Information
note that some variation in the location of data exploration and data visualization is acceptable
Data
[ ] I understand that a minimum requirement for case study acceptance is to successfully knit with no ERRORS or WARNINGS. Passing these checks does not result in automatic acceptance. The case study will then undergo a formal review and recommendations for acceptance regarding other standards will be addressed.
[ ] My case study addresses statistical or data science learning objectives.
[ ] I am committed to the long-term maintenance of my case study. This includes monitoring the repository for issues that users may have and responding promptly to requests for updates from the Core team in response to changes in R or underlying software.
For questions/help about the submission process, please contact us on our website.