Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
frfeng committed Nov 7, 2023
1 parent 75495da commit c13c266
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 25 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ jobs:
run: |
echo "::set-output name=count::$(shopt -s nullglob; files=($(find . -iname '*.Rmd')); echo ${#files[@]})"
- name: Set up R
if: steps.check-rmd.outputs.count != 0
uses: r-lib/actions/setup-r@master
with:
r-version: 'release'
# - name: Set up R
# if: steps.check-rmd.outputs.count != 0
# uses: r-lib/actions/setup-r@master
# with:
# r-version: 'release'

- name: Restore R Cache
if: steps.check-rmd.outputs.count != 0
Expand Down
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# U-M Carpentries Python Curriculum

[![website](https://github.com/UMCarpentries/intro-curriculum-python/actions/workflows/website.yml/badge.svg)](https://github.com/UMCarpentries/intro-curriculum-python/actions/workflows/website.yml)
[![check-links](https://github.com/UMCarpentries/intro-curriculum-python/actions/workflows/check-links.yml/badge.svg)](https://github.com/UMCarpentries/intro-curriculum-python/actions/workflows/check-links.yml)
<!-- [![check-links](https://github.com/UMCarpentries/intro-curriculum-python/actions/workflows/check-links.yml/badge.svg)](https://github.com/UMCarpentries/intro-curriculum-python/actions/workflows/check-links.yml) -->
[![License](https://img.shields.io/badge/License-MIT%2BCC--BY-blue)](LICENSE.md)

This is the custom curriculum developed by the University of Michigan Software
Carpentry instance.
It is in the `beta` stage of development; we are continuing to host workshops to
gather feedback and polish the curriculum.

The rendered website can be found [here](https://umcarpentries.github.io/intro-curriculum-python).
The rendered website can be found at [https://umcarpentries.org/intro-curriculum-python/](https://umcarpentries.org/intro-curriculum-python/).

## Repo Layout

Expand All @@ -23,13 +23,13 @@ The rendered website can be found [here](https://umcarpentries.github.io/intro-c

1. Lesson episodes

- `_episodes/` - Source files in markdown. Episode order is determined by the filename.
- `_episodes_rmd/` - Source files in R Markdown. A lesson should be written in one or the other markdown style, not both. To convert R Markdown files to markdown episodes, run `make lesson-rmd`.
- `_episodes/` - Source files in Markdown. Episode order is determined by the filename. Currently the lessons are directly written in Markdown inside this folder.
<!-- - `_episodes_rmd/` - Source files in R Markdown. A lesson should be written in one or the other markdown style, not both. To convert R Markdown files to markdown episodes, run `make lesson-rmd`. -->

Run `make lesson-check` at any time
to check that the lesson files follow the formatting rules
<!-- Run `make lesson-check` at any time -->
<!-- to check that the lesson files follow the formatting rules -->

1. Figures are stored in `fig/`, data sets in `data/`, source code in `code/`, and miscellaneous files in `files/`.
1. Figures are stored in `fig/`, data sets in `data/`, source notebooks in `_episodes_ipynb/`, and miscellaneous files in `files/`.

1. `_extras/`

Expand All @@ -38,7 +38,7 @@ The rendered website can be found [here](https://umcarpentries.github.io/intro-c
- `guide.md` - The instructor's guide for the curriculum.
- `bonus_exercises.md` - Bonus exercises for learners who want to practice more.

## Rendering R Markdown episodes
<!-- ## Rendering R Markdown episodes
To render all episodes in `_episodes_rmd/`, run:
Expand All @@ -52,7 +52,7 @@ To render just one episode, e.g. `_episodes_rmd/01-r-plotting.Rmd`, run:
```
make _episodes/01-r-plotting.md
```
``` -->

## Workshop Schedule

Expand All @@ -62,30 +62,30 @@ For a typical 2-day workshop. Can be modified for different workshop formats.
|---|-------|-------------|
| **Day 1** | |
| 09:00 | Welcome to the workshop | `_episodes/00-intro.md` |
| 09:15 | **R for Plotting** | `_episodes_rmd/01-r-plotting.Rmd` |
| 09:15 | **Python for Plotting** | `_episodes/01-python-plotting.md` |
| 10:30 | Break | |
| 10:45 | **R for Plotting (Continued)** | continuation of `01-r-plotting` |
| 10:45 | **Python for Plotting (Continued)** | continuation of `01-python-plotting.md` |
| 12:00 | Lunch Break | |
| 13:00 | **The Unix Shell** | `_episodes/02-unix-shell.md` |
| 14:15 | Break | |
| 14:30 | **Intro to git & GitHub** | `_episodes_rmd/03-intro-git-github.md` |
| 14:30 | **Intro to git & GitHub** | `_episodes/03-intro-git-github.md` |
| 16:30 | Wrap-up Day 1 | |
| **Day 2** | |
| 09:00 | **R for Data Analysis** | `_episodes_rmd/04-r-data-analysis.Rmd` |
| 09:00 | **Python for Data Analysis** | `_episodes/04-python-data-analysis.md` |
| 10:30 | Break | |
| 10:45 | **R for Data Analysis (Continued)** | continuation of `04-r-data-analysis` |
| 10:45 | **R for Data Analysis (Continued)** | continuation of `04-python-data-analysis.md` |
| 12:00 | Lunch Break | |
| 13:00 | **Writing Reports with R Markdown** | `_episodes_rmd/05-r-markdown.Rmd` |
| 13:00 | **Jupyter Notebook and Markdown** | `_episodes/05-markdown.md` |
| 14:30 | Break | |
| 14:45 | **Writing Reports with R Markdown (Continued)** | at end of `05-r-markdown` |
| 14:45 | **Jupyter Notebook and Markdown (Continued)** | at end of `05-markdown.md` |
| 16:00 | Conclusions & Wrap-up | `_episodes/06-conclusion.md` |
| 16:15 | Exit Survey | |
| 16:30 | End | |

## Helpful links

- How to format lesson files: https://carpentries.github.io/lesson-example/04-formatting/index.html
- Additional instructions for formatting R Markdown lesson files: https://carpentries.github.io/lesson-example/05-rmarkdown-example/index.html
<!-- - How to format lesson files: https://carpentries.github.io/lesson-example/04-formatting/index.html -->
<!-- - Additional instructions for formatting R Markdown lesson files: https://carpentries.github.io/lesson-example/05-rmarkdown-example/index.html -->
- The Carpentries lesson example repo (source files for the above two links): https://github.com/carpentries/lesson-example
- Already-established SWC curricula: https://github.com/swcarpentry/swcarpentry#lesson-repositories
- Lesson style guide: https://carpentries.github.io/lesson-example/06-style-guide/index.html
Expand Down
4 changes: 2 additions & 2 deletions _episodes/01-python-plotting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2218,7 +2218,7 @@ We can apply the `write_html()` method to save the plot to a standalone HTML fil
# Glossary of terms
_[Back to top](#contents)_
- Mark: an object that graphically represents data values. Examples of a mark include dots, bars, lines, areas, band, and paths. Each mark has a number of properties (e.g., color, size, opacity) that can be set to change its appearance.
- Facets: Dividing your data into non-overlapping groups and making a subplot for each subset of the data.
- Mark: an object that is used to graphically represents data values. Examples include dots, bars, lines, areas, band, and paths. Each mark has a number of properties (e.g., color, size, opacity) that can be set to change its appearance.
- Facets: Dividing your data into groups and making a subplot for each.
- Layer: Each plot is made up of one or more layers. Each layer contains one mark.
- Scale: specifying mappings from data units to visual properties.

0 comments on commit c13c266

Please sign in to comment.