OpenCore modules objectives and outlines developed during the curriculum sprint.
Learning Objectives
- Ethos of Open Science
- Open Data
- Open Software
- Open Results
- Open Tools and Resources
Lesson Outlines
- Ethos of Open Science
- Open Data
- Open Software
- Open Results
- Open Tools and Resources
- Explain why responsible Open Science matters to specific research projects, science writ large, and society;
- Explain the advantages and challenges of responsible Open Science
- Select Open Science communities that are compatible with a research project
- Explain how Open Science is critical for building public trust in science and influencing key societal challenges
- Describe the key components and behaviors of responsible Open Science
- Identify areas of concern in research that responsible Open Science can address.
- Include stakeholders who will benefit from research done with responsible Open Science
- Select responsible Open Science workflows
- Describe key characteristics of open data
- Categorize types of open data
- Communicate the benefits of Open data and its effects on science
- Communicate best practices for responsibly sharing data
- Explain the relationship between FAIR, CARE and Open Data
- Describe key features for effective data management planning
- Describe best practices for sharing open data
- Explain the benefits and challenges that producing open software encompasses.
- Be able to identify resources for Open Software relevant for a scientific field.
- Identify key markers of open software in code
- How to cite others’ software in publications
- Differentiate open, reproducible, and executable code
- Publish software openly so others may access, use, and grow the software
- Identify research stages and elements of research objects that can be considered results
- Identify the guiding practices and principles related to open results and the advantages of implementing them across stages of a research process
- Apply open result principles to new and ongoing research projects
- Identify paths for publicly communicating results
- Create open results contributor guidelines and opportunities for open and equitable collaborations
- Give credit to contributors in open results
- Contribute and provide constructive feedback to others’ results
- Explain why open science tools encourage responsible open science (e.g., using the FAIR and CARE principles)
- Identify Open Science communities and initiatives - within and across disciplines - and join a community of practice (CoP) of interest to you
- Provide examples of how open science is practiced in a research team
- Identify types of Open Science tools along with their purpose
- Match appropriate open science tools to specific objectives within the research workflow
- Describe 3-5 open science tools and how to use them in projects (e.g., for communication, sharing of results, giving credit, and collaboration)
Lesson 1: WHAT: Intro to Open Science: What is it and what does it promote?
- Introduction
- Context and Definition
- Definitions of Open Science and Responsible Open Science
- Open Science aspects
- There is no one ethos
- Performing open science responsibly
- Summary
- Further Reading
Lesson 2: WHY: Benefits and Challenges of Responsible Open Science: Why does it matter?
- Introduction
- Iof Open Science a. Quality of research b. Quality and diversity of scholarly communications c. Response to societal challenges d. Less unnecessary repetition is better for study participants e. Personal/career benefits
- Challenges in Open Science a. Not everything should be open - don’t overshare without consent! b. Preparing documentation, using standards, and creating metadata takes time and effort c. Open community members don’t always agree with each other d. Case scenarios in open communities e. Cultural barriers: not everyone wants to change, and institutions often move slowly f. Legal and security considerations
Lesson 3: WHO: Stakeholders of Open Science: Who practices Responsible Open Science and for whom?
- Introduction
- Who performs and benefits from open science? Stakeholders partaking in open science: a. Researchers b. Public c. Policy-makers
- How each group contributes to Open Science a. Case scenarios b. Case Scenario #1: Trend: Public —> Policy-makers c. Case Scenario #2: Officialize: Policy-makers—> Researchers/Public d. Case Scenario #3: Participate: Public —>Researchers e. Case Scenario #4: Share: Researchers —>Policy-makers/Public
- How diverse stakeholders are included in open science:
- Activity/exercise a. Case Scenario #1: Accessible figures and writing b. Case Scenario #2: Organizing an inclusive physical event c. Case Scenario #3: Organizing an inclusive virtual meeting and preparing in advance
- Summary
Lesson 4: WHERE: Impact of Open Science on academia, communities and society as a whole: Where open science happens.
- Introduction
- Legal frameworks that affect responsible open science a. Data protection, privacy, and data sovereignty b. European case: General Data Protection regulation c. South African case: Protection of Personal Information Act (POPI Act) and Open Science d. United States case: e. Summary: Working in a global society with varied data protection laws f. Intellectual property g. Whose laws apply to my community?
- Equity and Open Science
- A global perspective on open science a. UNESCO on Open Science Infrastructure b. Organisation for Economic Co-operation and Development (OECD) and Open Science
Lesson 5: HOW: Open Science resources & tools: How to get started in responsible open science (doing open science responsibly)
- Introduction a. Not an afterthought - plan for open science into the design
- Perks of digital and internet age for responsible open science
- Digital persistent identifiers - for objects and researchers a. ORCID: A permanent unique identifier for you, as a scientific author
- Sharing data, and software, and getting cited: Repositories you can use
- Intellectual property, copyright, and licensing your content so it can be reused
- Making your work useful to others
- Sharing and publishing your manuscript a. Public repository/Preprints b. Publishing Open Science and Open Access c. Discipline- and sector-specific nuances d. Working with physical samples and tools e. Authorship: recognizing the contributions and giving credit
- Summary: think beforehand, design for open science, never an afterthought
- Bonus section: Open Science Skills
Lesson 1: What is Open Data?
- Introduction
- What is Data? a. Definition of Data b. Primary (raw) Data c. Metadata
- What is Open Data? a. Availability and Accessibility b. Reusability c. Inclusivity
Lesson 2: Benefits of Open Data
- Introduction
- Open Data for the greater good
- Open data for better Open Science a. Validation b. Transparency c. Collaboration
- Open Data to support policy change
- Open Data in face of global emergencies
- Open Data and public engagement (citizen science)
- Open Data and equitable knowledge sharing
Lesson 3: Responsible Open Data
- Introduction
- Empowering Individuals and Communities through Open Data a. Lack of protective frameworks b. Lack of proper informed consent c. Lack of equitable participation
- Managing Data Responsibly
Lesson 4: Principles of Data Sharing
- Introduction
- FAIR (Findable, Accessible, Interoperable, Reusable) a. FAIR Principles Explained b. FAIR in short
- CARE Principles of Indigenous Data Sovereignty a. Collective Benefit b. Authority to Control c. Responsibility d. Ethics
- Identifying principles relevant to your community or other resources for principles (e.g. Environmental Justice).
Lesson 5: Planning for Open Data
- The Data Life Cycle
- Data Management Plans (DMP)
- Documenting your Data (Metadata)
- Help a. Research Communities (international and national) b. Open Science related communities c. Tools and resources d. Local Library or IT Services
Lesson 6: Sharing Open Data
- Policies for Responsible Sharing of Open Data
- Licenses for Open Data
- Citations and Acknowledgements
- Repositories and Other Sharing Methods a. Domain Specific Repositories b. Institutional Repository c. National Repositories d. General Repository
- Data Access/Data Availability Statements
Lesson 7: Finding and Using Open Data
- Discovering data that is open and usable
- Determining any usage restrictions
- Mitigating access barriers
Lesson 1: Open software in the context of Open Science
- Introduction
- Open Science Principles: How they relate to software/code
- Open Software and Open as a Spectrum a. Source Code b. Open Source Software (OSS)
- Core Principles of Open Source Software: What research software can move towards a. Closed source software b. Transparency c. Participation d. Collaboration
- Summary
Lesson 2: The Pros and Cons of Open Software
- Introduction
- Benefits of Open Science
- Are there any disadvantages of open software - and if so, how to mitigate them? a. As a user b. As a developer
- Summary
Lesson 3: Licensing/Ownership & DOI's
- Introduction
- Licenses a. Types of licenses b. How to choose a license
- Attribution and citation a. Digital Object Identifier (DOI) b. Citing Code without a DOI c. Attribution for pieces/snippets of code d. Publishing open software in peer-reviewed journals
- External Requirements
- Summary
Lesson 4: Code management/Quality
- Introduction
- What does it mean for software/code to be of good quality? a. Good documentation b. Clean/readable code
- Summary
- References
Lesson 5: Maintain good code quality
- Introduction
- Version Control
- Testing
- Responsibilities after Sharing
- Responsibilities for ongoing maintenance
Lesson 6: Contributing to existing open software
- Introduction
- Benefits of contributing to an open software
- Types of contribution to open software a. Add new features b. Fix bugs/issues c. Report issues/ suggestions about improving code d. Improving and contributing to documentation e. Create tutorials, use cases, or visuals f. Improve layout, automatization, structure of code g. Organize/attend a meetup/community building h. Code review i. Help organizing funding and support for the project
- How to contribute a. Contributing via version control system b. Type of Commits c. Branching and Merging d. Merge conflicts
- Recommended Practices
- Naming Etiquette
- Ethical Considerations
- Summary
Lesson 1: The Research Process and Its Results
- What are the different stages of the research process?
- Define “digital research objects” and provide examples
Lesson 2: Results in the Context of Open Science
- What are the advantages of making results open throughout the research process?
- What resources are available to help make results open?
- What are the guiding principles to turn a research result into an open result?
Lesson 3: Applying Open Result Framework to your Research
- How to apply an open framework across different research objects
- How to share your results, and selecting **tools **that support open science?
- Using a checklist to achieve open results
Lesson 4: Providing Equitable Opportunities and Credit for Contributors to Results
- How to define contributors to each digital research object and determine their suitable form of recognition?
- How to create contributor guidelines that ensure equity, access, inclusion, diversity
- How to ensure your open results are properly attributed and cited by others
Lesson 1: Introduction to Open Science tools
- Definition: What do we mean by “Open Science tools”?
- What’s the difference between ‘open’ and ‘closed’ tools? Why use Open Science tools?
- How do Open Science tools fit into the research lifecycle?
- How do Open Science tools address responsible practices
Lesson 2: Open Science tools across the research lifecycle
- Open Science tools for protocols
- Open Science tools for data a. Sharing data with your (research) team b. Data repositories
- Open Science tools for code a. Collaborative development tools b. Code repositories
- Open Science tools for results
- Open Science tools for authoring a. Collaborative writing tools b. Reference management tools c. Publishing Open Science and Open Access
Lesson 3: Open Science tools for reproducibility
- What is reproducibility?
- Computational notebooks a. Jupyter b. R Markdown c. Quarto
Lesson 4: Open Science communities
- Why engage with Open Science communities?
- What is a Community of Practice (CoP)? a. Communities list
- How to engage with Open Science communities a. Pathways for contribution b. Pathways for collaboration c. Pathways for engagement
- How to build and lead a community a. Guidelines for building communities b. Mountain of engagement