Skip to content

Commit

Permalink
Initial customization
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt Thompson committed Dec 2, 2024
1 parent 770e2ec commit 96a5218
Show file tree
Hide file tree
Showing 4 changed files with 148 additions and 149 deletions.
12 changes: 6 additions & 6 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ carpentry: "swc"
# dc-image: for Data Carpentry Image Processing
# swc-inflammation: for Software Carpentry based on the inflammation dataset
# swc-gapminder: for Software Carpentry based on the Gapminder dataset
curriculum: "FIXME"
curriculum: "swc-gapminder"

# If there is both an R and python official version of a curriculum
# (as listed on https://software-carpentry.org/lessons/ and
# https://datacarpentry.org/lessons/), change the
# value of the variable below ("flavor") to get the schedule and installation
# instructions updated accordingly (valid values are 'r' or 'python').
# Note: this is only for Data Carpentry and SWC at this time.
flavor: "FIXME"
flavor: "r"

# If the workshop will be a lesson pilot (for a new official lesson or
# a lesson in The Carpentries Incubator), set pilot to "true"
Expand All @@ -53,7 +53,7 @@ pilot: false
# Most workshops don't use extra pages. More information about extra
# pages are included in the README:
# https://github.com/carpentries/workshop-template#creating-extra-pages
title: "Workshop Title"
title: "OSU Software Carpentries: Version Control with Git and R for Scientific Reproducibility"

#------------------------------------------------------------
# Incubator workshop settings (only relevant for workshops teaching a lesson
Expand Down Expand Up @@ -110,11 +110,11 @@ workshop_site: "https://carpentries.github.io/workshop-template"
cc_by_human: "https://creativecommons.org/licenses/by/4.0/"

# Surveys.
pre_survey: "https://carpentries.typeform.com/to/wi32rS?slug="
post_survey: "https://carpentries.typeform.com/to/UgVdRQ?slug="
pre_survey: "https://carpentries.typeform.com/to/wi32rS?slug=2025-02-11-osu-online"
post_survey: "https://carpentries.typeform.com/to/UgVdRQ?slug=2025-02-11-osu-online"

# Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
start_time: 0
start_time: 540

# Specify that things in the episodes collection should be output.
collections:
Expand Down
115 changes: 67 additions & 48 deletions _includes/custom-schedule.html
Original file line number Diff line number Diff line change
@@ -1,72 +1,91 @@
<div class="row"> <!-- first two days -->
<div class="col-md-6"> <!-- left column -->
<h3>Day 1</h3>
<h3>Day 1 or 2</h3>
<table class="table table-striped">
<tr> <!-- row 1 -->
<tr>
<td>Before starting</td>
<td><a href="{{ site.pre_survey }}{{ site.github.project_title }}" target="_blank">Pre-workshop survey</a></td>
<td>
Set up <a href="https://imageomics.github.io/2024-08-16-osu-online/#the-bash-shell" target="_blank">Bash</a>
and
<a href="https://imageomics.github.io/2024-08-16-osu-online/#git-1" target="_blank">Git</a>.
</td> </tr>
<tr>
<td>9:00</td>
<td><a href="{{ site.pre_survey }}{{ site.github.project_title }}" target="_blank">Pre-workshop survey</a>, intro, logistics</td>
</tr>
<tr> <!-- row 2 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>9:20</td>
<td>Navigating the Shell</td>
</tr>
<tr> <!-- row 3 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>10:05</td>
<td>Break</td>
</tr>
<tr>
<td>10:20</td>
<td>Version Control with Git: Command Line</td>
</tr>
<tr>
<td>11:30</td>
<td>Lunch</td>
</tr>
<tr>
<td>12:30</td>
<td>Version Control with Git: Remotes</td>
</tr>
<tr>
<td>1:50</td>
<td><a href="{{ site.post_survey }}{{ site.github.project_title }}" target="_blank">Post-workshop survey</a> (if not attending on Monday)</td>
</tr>
<tr>
<td>3:00</td>
<td>END</td>
</tr>
</table>
</div>
<div class="col-md-6"> <!-- right column -->
<h3>Day 2</h3>
<h3>Day 1 or 2</h3>
<table class="table table-striped">
<tr> <!-- row 1 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>Before starting</td>
<td>Set up <a href="https://imageomics.github.io/2024-08-16-osu-online/#r-1" target="_blank">R and RStudio</a>.</td>
</tr>
<tr> <!-- row 2 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>9:00</td>
<td><a href="{{ site.pre_survey }}{{ site.github.project_title }}" target="_blank">Pre-workshop survey</a> (if only attending today), intro, logistics</td>
</tr>
<tr> <!-- row 3 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>9:20</td>
<td>Introduction to R and RStudio</td>
</tr>
</table>
</div>
</div>
<div class="row"> <!-- days 3 and 4 -->
<div class="col-md-6"> <!-- left column -->
<h3>Day 3</h3>
<table class="table table-striped">
<tr> <!-- row 1 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>10:15</td>
<td>Break</td>
</tr>
<tr> <!-- row 2 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>10:30</td>
<td>Data structures</td>
</tr>
<tr> <!-- row 3 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>11:25</td>
<td>Data Frame manipulation with <code>dplyr</code></td>
</tr>
</table>
</div>
<div class="col-md-6"> <!-- right column -->
<h3>Day 4</h3>
<table class="table table-striped">
<tr> <!-- row 1 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>12:30</td>
<td>Lunch</td>
</tr>
<tr> <!-- row 2 -->
<td></td> <!-- time -->
<td></td> <!-- content -->
<tr>
<td>1:30</td>
<td>Visualization with <code>ggplot2</code></td>
</tr>
<tr> <!-- row 3 -->
<td>End</td>
<tr>
<td>2:50</td>
<td><a href="{{ site.post_survey }}{{ site.github.project_title }}" target="_blank">Post-workshop survey</a></td>
</tr>
<tr>
<td>3:00</td>
<td>END</td>
</tr>
</table>
</div>
</div>
116 changes: 61 additions & 55 deletions _includes/install_instructions/r.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,62 +6,68 @@ <h3>R</h3>
that is especially powerful for data exploration, visualization, and
statistical analysis. To interact with R, we use
<a href="https://posit.co/products/open-source/rstudio/">RStudio</a>.
Note: R version 4.1 or newer should be used, which will be achieved
by following the directions for your system below.
</p>
<p>
If you are comfortable doing so, please execute the commands <code>install.packages("tidyverse")</code>
and <code>install.packages("gapminder")</code> in the RStudio console ahead of the workshop.
</p>

<div>
<ul class="nav nav-tabs" role="tablist">
<li role="presentation" class="active"><a data-os="windows" href="#rstats-windows" aria-controls="Windows" role="tab" data-toggle="tab">Windows</a></li>
<li role="presentation"><a data-os="macos" href="#rstats-macos" aria-controls="MacOS" role="tab" data-toggle="tab">MacOS</a></li>
<li role="presentation"><a data-os="linux" href="#rstats-linux" aria-controls="Linux" role="tab" data-toggle="tab">Linux</a></li>
</ul>

<div>
<ul class="nav nav-tabs" role="tablist">
<li role="presentation" class="active"><a data-os="windows" href="#rstats-windows" aria-controls="Windows" role="tab" data-toggle="tab">Windows</a></li>
<li role="presentation"><a data-os="macos" href="#rstats-macos" aria-controls="MacOS" role="tab" data-toggle="tab">MacOS</a></li>
<li role="presentation"><a data-os="linux" href="#rstats-linux" aria-controls="Linux" role="tab" data-toggle="tab">Linux</a></li>
</ul>

<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="rstats-windows">
<p>
Install R by downloading and running
<a href="https://cran.r-project.org/bin/windows/base/release.htm">this .exe file</a>
from <a href="https://cran.r-project.org/index.html">CRAN</a>.
Also, please install the
<a href="https://posit.co/download/rstudio-desktop/">RStudio IDE</a>.
Note that if you have separate user and admin accounts, you should run the
installers as administrator (right-click on .exe file and select "Run as
administrator" instead of double-clicking). Otherwise problems may occur later,
for example when installing R packages.
</p>
<h4>Video Tutorial</h4>
<div class="yt-wrapper2">
<div class="yt-wrapper">
<iframe type="text/html" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" src="https://www.youtube-nocookie.com/embed/q0PjTAylwoU?modestbranding=1&playsinline=1&iv_load_policy=3&rel=0" class="yt-frame" allowfullscreen></iframe>
</div>
</div>
</article>
<article role="tabpanel" class="tab-pane" id="rstats-macos">
<p>
Install R by downloading and running
<a href="https://cran.r-project.org/bin/macosx/R-latest.pkg">this .pkg file</a>
from <a href="https://cran.r-project.org/index.html">CRAN</a>.
Also, please install the
<a href="https://posit.co/download/rstudio-desktop/">RStudio IDE</a>.
</p>
<h4>Video Tutorial</h4>
<div class="yt-wrapper2">
<div class="yt-wrapper">
<iframe type="text/html" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" src="https://www.youtube-nocookie.com/embed/5-ly3kyxwEg?modestbranding=1&playsinline=1&iv_load_policy=3&rel=0" class="yt-frame" allowfullscreen></iframe>
</div>
</div>
</article>
<article role="tabpanel" class="tab-pane" id="rstats-linux">
<p>
Instructions for R installation on various Linux platforms (debian,
fedora, redhat, and ubuntu) can be found at
<https://cran.r-project.org/bin/linux/>. These will instruct you to
use your package manager (e.g. for Fedora run
<code>sudo dnf install R</code> and for Debian/Ubuntu, add a ppa
repository and then run <code>sudo apt-get install r-base</code>).
Also, please install the
<a href="https://posit.co/download/rstudio-desktop/">RStudio IDE</a>.
</p>
</article>
<div class="tab-content">
<article role="tabpanel" class="tab-pane active" id="rstats-windows">
<p>
Install R by downloading and running
<a href="https://cran.r-project.org/bin/windows/base/release.htm">this .exe file</a>
from <a href="https://cran.r-project.org/index.html">CRAN</a>.
Also, please install the
<a href="https://posit.co/download/rstudio-desktop/">RStudio IDE</a>.
Note that if you have separate user and admin accounts, you should run the
installers as administrator (right-click on .exe file and select "Run as
administrator" instead of double-clicking). Otherwise problems may occur later,
for example when installing R packages.
</p>
<h4>Video Tutorial</h4>
<div class="yt-wrapper2">
<div class="yt-wrapper">
<iframe type="text/html" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" src="https://www.youtube-nocookie.com/embed/q0PjTAylwoU?modestbranding=1&playsinline=1&iv_load_policy=3&rel=0" class="yt-frame" allowfullscreen></iframe>
</div>
</div>
</article>
<article role="tabpanel" class="tab-pane" id="rstats-macos">
<p>
Install R by downloading and running
<a href="https://cran.r-project.org/bin/macosx/R-latest.pkg">this .pkg file</a>
from <a href="https://cran.r-project.org/index.html">CRAN</a>.
Also, please install the
<a href="https://posit.co/download/rstudio-desktop/">RStudio IDE</a>.
</p>
<h4>Video Tutorial</h4>
<div class="yt-wrapper2">
<div class="yt-wrapper">
<iframe type="text/html" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" src="https://www.youtube-nocookie.com/embed/5-ly3kyxwEg?modestbranding=1&playsinline=1&iv_load_policy=3&rel=0" class="yt-frame" allowfullscreen></iframe>
</div>
</div>
</article>
<article role="tabpanel" class="tab-pane" id="rstats-linux">
<p>
Instructions for R installation on various Linux platforms (debian,
fedora, redhat, and ubuntu) can be found at
<https://cran.r-project.org/bin/linux/>. These will instruct you to
use your package manager (e.g. for Fedora run
<code>sudo dnf install R</code> and for Debian/Ubuntu, add a ppa
repository and then run <code>sudo apt-get install r-base</code>).
Also, please install the
<a href="https://posit.co/download/rstudio-desktop/">RStudio IDE</a>.
</p>
</article>
</div>
</div>
</div>
</div>
54 changes: 14 additions & 40 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ layout: workshop # DON'T CHANGE THIS.
# More detailed instructions (including how to fill these variables for an
# online workshop) are available at
# https://carpentries.github.io/workshop-template/customization/index.html
venue: "FIXME" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "FIXME" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "FIXME" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "FIXME" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "45" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "-1" # decimal longitude of the workshop venue (use https://www.latlong.net)
humandate: "FIXME" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "FIXME" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: FIXME # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: FIXME # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
instructor: ["instructor one", "instructor two"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
helper: ["helper one", "helper two"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
email: ["[email protected]","[email protected]"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["[email protected]", "[email protected]", "[email protected]"]
venue: "Ohio State University" # brief name of the institution that hosts the workshop without address (e.g., "Euphoric State University")
address: "online" # full street address of workshop (e.g., "Room A, 123 Forth Street, Blimingen, Euphoria"), videoconferencing URL, or 'online'
country: "us" # lowercase two-letter ISO country code such as "fr" (see https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) for the institution that hosts the workshop
language: "en" # lowercase two-letter ISO language code such as "fr" (see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the workshop
latitude: "39.997341" # decimal latitude of workshop venue (use https://www.latlong.net/)
longitude: "-83.014549" # decimal longitude of the workshop venue (use https://www.latlong.net)
humandate: "February 11 and 14, 2025" # human-readable dates for the workshop (e.g., "Feb 17-18, 2020")
humantime: "9:00 am - 3:00 pm and 9:00 am - 3:00 pm EST" # human-readable times for the workshop e.g., "9:00 am - 4:30 pm CEST (7:00 am - 2:30 pm UTC)"
startdate: 2024-02-11 # machine-readable start date for the workshop in YYYY-MM-DD format like 2015-01-01
enddate: 2024-02-14 # machine-readable end date for the workshop in YYYY-MM-DD format like 2015-01-02
instructor: ["Matthew Thompson, PhD","Elizabeth Campolongo, PhD", "Jessica Cooperstone, PhD", "Jelmer Poelstra, PhD", "Horacio Lopez-Nicora, PhD"] # boxed, comma-separated list of instructors' names as strings, like ["Kay McNulty", "Betty Jennings", "Betty Snyder"]
helper: ["TBD"] # boxed, comma-separated list of helpers' names, like ["Marlyn Wescoff", "Fran Bilas", "Ruth Lichterman"]
email: ["[email protected]", "[email protected]"] # boxed, comma-separated list of contact email addresses for the host, lead instructor, or whoever else is handling questions, like ["[email protected]", "[email protected]", "[email protected]"]
collaborative_notes: # optional: URL for the workshop collaborative notes, e.g. an Etherpad or Google Docs document (e.g., https://pad.carpentries.org/2015-01-01-euphoria)
eventbrite: # optional: alphanumeric key for Eventbrite registration, e.g., "1234567890AB" (if Eventbrite is being used)
what3words: # optional: what3words (https://what3words.com) address of the workshop venue, without leading slashes e.g. "globe.lessening.computers"
Expand All @@ -33,32 +33,6 @@ And run 'make workshop-check' *before* committing to make sure that changes are
{% endcomment %}



{% comment %}
8< ============= For a workshop delete from here =============
For a workshop please delete the following block until the next dashed-line
{% endcomment %}


<div class="alert alert-danger">
This is the workshop template. Delete these lines and use it to
<a href="https://carpentries.github.io/workshop-template/customization/index.html">customize</a>
your own website. If you are running a self-organized workshop or have not put
in a workshop request yet, please also fill in
<a href="{{site.amy_site}}/forms/self-organised/">this workshop request form</a>
to let us know about your workshop and our administrator may contact you if we
need any extra information.
If this is a pilot workshop for a new lesson,
set the `pilot` field to `true` in `_config.yml`.
For workshops teaching a lesson in The Carpentries Incubator,
remember to uncomment the `incubator_lesson_site`, `incubator_pre_survey`, and `incubator_post_survey`
fields in `_config.yml`
</div>

{% comment %}
8< ============================= until here ==================
{% endcomment %}

{% comment %}
Check DC curriculum
{% endcomment %}
Expand Down Expand Up @@ -403,7 +377,7 @@ of code below the Schedule `<h2>` header below with
<h2 id="schedule">Schedule</h2>

{% if site.carpentry == "swc" %}
{% include swc/schedule.html %}
{% include custom-schedule.html %}
{% elsif site.carpentry == "dc" %}
{% include dc/schedule.html %}
{% elsif site.carpentry == "lc" %}
Expand Down

0 comments on commit 96a5218

Please sign in to comment.