Skip to content

ptuan5/better-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Better Code, Better Science

This repository contains materials for the 5-day workshop Better Code, Better Science: Next Steps in R & Python Practices, taught by Tuan Nguyen on April 13-17, 2026.

Overview

This workshop combines discussion and hands-on practice focused on improving code in R and Python. The repository is organized by day so that notes, activities, and language-specific materials stay grouped together.

Learning Objectives

By the end of the workshop, participants will be able to:

  1. Write clear, readable, and well-documented code.
  2. Refactor repeated code into reusable functions.
  3. Build more reproducible workflows.
  4. Review code critically and test important logic.
  5. Organize work so it is easier to share with others.

Repository Structure

.
|-- documents/
|   |-- syllabus.md
|   |-- activity-breakdown.md
|   `-- slides/
|-- teaching/
`-- modules/
    |-- day-01-readable/
    |-- day-02-reusable/
    |-- day-03-reproducible/
    |-- day-04-reliable/
    `-- day-05-shareable/

Within each day:

day-0x-...
|-- agenda.md
|-- activities/
|   |-- activity-1/
|   `-- activity-2/
`-- demos/

Where to Find Things

  • documents/: course-wide materials, including the syllabus, activity breakdown, and shared slide files
  • teaching/: instructor-facing notes grouped by day
  • modules/: one folder for each workshop day

Within each day:

  • agenda.md: the day schedule and flow
  • activities/: learner prompts and activity-specific materials
  • demos/: short demo materials and worked examples used during teaching

How to Use This Repository

Start with the materials in documents/ for the overall course structure. Then use the relevant folder in modules/ for each day's learner-facing agenda and activities. If you are teaching the workshop, use teaching/ for instructor-facing notes and facilitation guidance.

About

Materials for a workshop in good coding practice at the Jackson Lab, 2026

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors