Good data and project or software documentation make your work more discoverable, transparent and reusable. One tool that helps simplify technical documentation is the software platform Read the Docs. This free and open source platform automates the building, versioning and hosting of your docs.
Join the BioData Club at OHSU for the workshop: DIY Documentation with Read the Docs.
In this hands-on BioData Club and OHSU Library workshop, instructors Eric Earl and Robin Champieux will introduce attendees to documentation best practices and guide them through the process of publishing a documentation website using Read the Docs and Markdown.
All OHSU community members and friends are welcome! No prior experience is required, but please register in advance. BioData Club Workshop
DIY documentation with Read the Docs
Friday, Oct. 18, 4 to 5:30 p.m.
BICC 124
Registration requested
Before the workshop
Attendees should bring a laptop and install the following software:
1. Download & install Visual Studio Code
2. Sign up for a GitHub account
3. Sign up for a Read the Docs account using your GitHub account
About BioData Club
BioData Club is an informal community at OHSU dedicated to promoting a fun and supportive culture of interdisciplinary co-learning in data science skills and open science principles. We welcome everyone at all skill levels who aim to better their skills in all things data. We want to replace statistics anxiety and code fear with inspiration and motivation to learn and share. BioData Club is a partnership of the OHSU Library and DMICE.
November and January BioData Club meetings
Data Storytelling
Location: BICC 124You are making a figure for your paper and want it to be the best it can be. Come and learn techniques for communicating your findings clearly. Learn about the role of color, annotations, and simplifying your figures to communicate effectively.
How to Make a Reproducible Paper
January 10, 2020, 4 to 5:30 p.m.
Location: BICC 124
In this workshop, Aurora Blucher will talk about making a publication reproducible. Come and learn about effective data management, building reproducible computing environments using Binder, and using RMarkdown notebooks to make reproducible result reports.
