[custom] fix lesson contents

datacarpentry · Sep 18, 2023 · 4d9e072 · 4d9e072
1 parent 532a7f1
commit 4d9e072
Show file tree

Hide file tree

Showing 14 changed files with 125 additions and 109 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -8,6 +8,8 @@ we pledge to follow the [The Carpentries Code of Conduct][coc].
 Instances of abusive, harassing, or otherwise unacceptable behavior
 may be reported by following our [reporting guidelines][coc-reporting].
 
-
-[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
 [coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html
+[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
+
+
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,18 +21,18 @@ mistake, some awkward wording, or a factual error. This is a good way to
 introduce yourself and to meet some of our community members.
 
 1. If you do not have a [GitHub][github] account, you can [send us comments by
-   email][contact]. However, we will be able to respond more quickly if you use
-   one of the other methods described below.
+  email][contact]. However, we will be able to respond more quickly if you use
+  one of the other methods described below.
 
 2. If you have a [GitHub][github] account, or are willing to [create
-   one][github-join], but do not know how to use Git, you can report problems
-   or suggest improvements by [creating an issue][repo-issues]. This allows us
-   to assign the item to someone and to respond to it in a threaded discussion.
+  one][github-join], but do not know how to use Git, you can report problems
+  or suggest improvements by [creating an issue][repo-issues]. This allows us
+  to assign the item to someone and to respond to it in a threaded discussion.
 
 3. If you are comfortable with Git, and would like to add or change material,
-   you can submit a pull request (PR). Instructions for doing this are
-   [included below](#using-github). For inspiration about changes that need to
-   be made, check out the [list of open issues][issues] across the Carpentries.
+  you can submit a pull request (PR). Instructions for doing this are
+  [included below](#using-github). For inspiration about changes that need to
+  be made, check out the [list of open issues][issues] across the Carpentries.
 
 Note: if you want to build the website locally, please refer to [The Workbench
 documentation][template-doc].
@@ -41,8 +41,7 @@ documentation][template-doc].
 
 1. If you wish to change this lesson, add issues and pull requests here.
 2. If you wish to change the template used for workshop websites, please refer
-   to [The Workbench documentation][template-doc].
-
+  to [The Workbench documentation][template-doc].
 
 ### What to Contribute
 
@@ -80,12 +79,12 @@ Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we
 use [GitHub flow][github-flow] to manage changes:
 
 1. Create a new branch in your desktop copy of this repository for each
-   significant change.
+  significant change.
 2. Commit the change in that branch.
 3. Push that branch to your fork of this repository on GitHub.
 4. Submit a pull request from that branch to the [upstream repository][repo].
 5. If you receive feedback, make changes on your desktop and push to your
-   branch on GitHub: the pull request will update automatically.
+  branch on GitHub: the pull request will update automatically.
 
 NB: The published copy of the lesson is usually in the `main` branch.
 
@@ -98,26 +97,26 @@ final say over what gets merged into the lesson.
 The Carpentries is a global organisation with volunteers and learners all over
 the world. We share values of inclusivity and a passion for sharing knowledge,
 teaching and learning. There are several ways to connect with The Carpentries
-community listed at <https://carpentries.org/connect/> including via social
+community listed at [https://carpentries.org/connect/](https://carpentries.org/connect/) including via social
 media, slack, newsletters, and email lists. You can also [reach us by
 email][contact].
 
-[repo]: https://example.com/FIXME
-[repo-issues]: https://example.com/FIXME/issues
-[contact]: mailto:team@carpentries.org
 [cp-site]: https://carpentries.org/
-[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
-[dc-lessons]: https://datacarpentry.org/lessons/
+[swc-site]: https://software-carpentry.org/
 [dc-site]: https://datacarpentry.org/
-[discuss-list]: https://carpentries.topicbox.com/groups/discuss
+[lc-site]: https://librarycarpentry.org/
 [github]: https://github.com
-[github-flow]: https://guides.github.com/introduction/flow/
+[contact]: mailto:team@carpentries.org
 [github-join]: https://github.com/join
-[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
+[repo-issues]: https://github.com/datacarpentry/socialsci-workshop/issues
 [issues]: https://carpentries.org/help-wanted-issues/
+[template-doc]: https://carpentries.github.io/workbench/
+[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
 [lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry
 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
-[swc-lessons]: https://software-carpentry.org/lessons/
-[swc-site]: https://software-carpentry.org/
-[lc-site]: https://librarycarpentry.org/
-[template-doc]: https://carpentries.github.io/workbench/
+[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
+[github-flow]: https://guides.github.com/introduction/flow/
+[repo]: https://github.com/datacarpentry/socialsci-workshop
+
+
+
diff --git a/LICENSE.md b/LICENSE.md
@@ -12,8 +12,8 @@ license][cc-by-legal].
 
 You are free:
 
-- to **Share**---copy and redistribute the material in any medium or format
-- to **Adapt**---remix, transform, and build upon the material
+- to **Share**\---copy and redistribute the material in any medium or format
+- to **Adapt**\---remix, transform, and build upon the material
 
 for any purpose, even commercially.
 
@@ -22,30 +22,30 @@ terms.
 
 Under the following terms:
 
-- **Attribution**---You must give appropriate credit (mentioning that your work
+- **Attribution**\---You must give appropriate credit (mentioning that your work
   is derived from work that is Copyright (c) The Carpentries and, where
-  practical, linking to <https://carpentries.org/>), provide a [link to the
+  practical, linking to [https://carpentries.org/](https://carpentries.org/)), provide a [link to the
   license][cc-by-human], and indicate if changes were made. You may do so in
   any reasonable manner, but not in any way that suggests the licensor endorses
   you or your use.
 
-- **No additional restrictions**---You may not apply legal terms or
+- **No additional restrictions**\---You may not apply legal terms or
   technological measures that legally restrict others from doing anything the
   license permits.  With the understanding that:
 
 Notices:
 
-* You do not have to comply with the license for elements of the material in
+- You do not have to comply with the license for elements of the material in
   the public domain or where your use is permitted by an applicable exception
   or limitation.
-* No warranties are given. The license may not give you all of the permissions
+- No warranties are given. The license may not give you all of the permissions
   necessary for your intended use. For example, other rights such as publicity,
   privacy, or moral rights may limit how you use the material.
 
 ## Software
 
 Except where otherwise noted, the example programs and other software provided
-by The Carpentries are made available under the [OSI][osi]-approved [MIT
+by The Carpentries are made available under the [OSI][osi]\-approved [MIT
 license][mit-license].
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -74,6 +74,9 @@ Initiatives][ci].
 
 [cc-by-human]: https://creativecommons.org/licenses/by/4.0/
 [cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
+[osi]: https://opensource.org
 [mit-license]: https://opensource.org/licenses/mit-license.html
 [ci]: https://communityin.org/
-[osi]: https://opensource.org
+
+
+
diff --git a/config.yaml b/config.yaml
@@ -14,7 +14,7 @@ carpentry: 'dc'
 title: 'Social Science Workshop Overview'
 
 # Date the lesson was created (YYYY-MM-DD, this is empty by default)
-created: ~ # FIXME
+created: '2017-05-25'
 
 # Comma-separated list of keywords for the lesson
 keywords: 'software, data, lesson, The Carpentries' # FIXME

diff --git a/files/setup-python.md b/files/setup-python.md
@@ -15,7 +15,7 @@
   With Miniconda you will need to install the required packages.
   We recommend using the Anaconda installation instructions.
 
-:::::::::::::::  solution
+:::::::::::::::: spoiler
 
 ## Anaconda installation
 
@@ -30,7 +30,7 @@ conda install -c conda-forge plotnine
 
 :::::::::::::::::::::::::
 
-:::::::::::::::  solution
+:::::::::::::::: spoiler
 
 ## Miniconda installation
 

diff --git a/files/setup-r.md b/files/setup-r.md
@@ -15,7 +15,7 @@
 
 #### Windows
 
-:::::::::::::::  solution
+:::::::::::::::: spoiler
 
 ## If you already have R and RStudio installed
 
@@ -34,7 +34,7 @@ You can [uninstall older versions of R][uninstall-r] if you wish to do so.
 
 :::::::::::::::::::::::::
 
-:::::::::::::::  solution
+:::::::::::::::: spoiler
 
 ## If you don't have R and RStudio installed
 
@@ -52,7 +52,7 @@ You can [uninstall older versions of R][uninstall-r] if you wish to do so.
 
 #### macOS
 
-:::::::::::::::  solution
+:::::::::::::::: spoiler
 
 ## If you already have R and RStudio installed
 
@@ -68,7 +68,7 @@ You can [uninstall older versions of R][uninstall-r] if you wish to do so.
 
 :::::::::::::::::::::::::
 
-:::::::::::::::  solution
+:::::::::::::::: spoiler
 
 ## If you don't have R and RStudio installed
 

diff --git a/index.md b/index.md
@@ -35,7 +35,6 @@ This workshop assumes no prior experience with the tools covered in the workshop
 To get started, follow the directions in the [Setup](learners/setup.md) tab to
 get access to the required software and data for this workshop.
 
-
 ::::::::::::::::::::::::::::::::::::::::::::::::::
 
 ::::::::::::::::::::::::::::::::::::::::::  prereq
@@ -64,15 +63,15 @@ This curriculum is currently available using R as the main programming language.
 # Workshop Overview
 
 | Lesson | Overview                                                                                                                                                         | 
-| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
 | [Data Organization in Spreadsheets](https://datacarpentry.github.io/spreadsheets-socialsci/)       | Learn how to organize tabular data, handle date formatting, carry out quality control and quality assurance and export data to use with downstream applications. | 
 | [Data Cleaning with OpenRefine](https://datacarpentry.github.io/openrefine-socialsci/)       | Explore, summarize, and clean tabular data reproducibly.                                                                                                         | 
 | [Data Analysis and Visualisation with R](https://datacarpentry.github.io/r-socialsci)       | Import data into R, calculate summary statistics, and create publication-quality graphics.                                                                       | 
 
 # Workshop Materials in Development
 
 | Lesson | Overview                                                                                                                                                         | 
-| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
 | [Data Analysis and Visualisation with Python](https://datacarpentry.github.io/python-socialsci/)       | Import data into Python, calculate summary statistics, and create publication-quality graphics.                                                                  | 
 | [Data Management with SQL](https://datacarpentry.github.io/sql-socialsci/)       | Extract information from relational databases.                                                                                                                   | 
 

diff --git a/instructors/instructor-notes.md b/instructors/instructor-notes.md
@@ -8,9 +8,9 @@ The following table provides links to instructor notes and timings for each less
 
 | Lesson | Link to Instructor Notes | Length | 
 | ------ | ------------------------ | ------ |
-| [Data Organization in Spreadsheets for Social Scientists](https://datacarpentry.org/spreadsheets-socialsci/)       | [Notes](https://datacarpentry.org/spreadsheets-socialsci/guide/)                         | **2 hours**       | 
-| [Data Cleaning with Open Refine](https://datacarpentry.org/openrefine-socialsci/)       | [Notes](https://datacarpentry.org/openrefine-socialsci/guide/)                         | **2 hours**       | 
-| [Data Analysis and Visualization in R](https://datacarpentry.org/r-socialsci/)       | [Notes](https://datacarpentry.org/r-socialsci/guide/index.html)                         | **6\.5 hours**       | 
+| [Data Organization in Spreadsheets for Social Scientists](https://datacarpentry.org/spreadsheets-socialsci/)       | [Notes](https://datacarpentry.org/spreadsheets-socialsciinstructor/instructor-notes.html)                         | **2 hours**       | 
+| [Data Cleaning with Open Refine](https://datacarpentry.org/openrefine-socialsci/)       | [Notes](https://datacarpentry.org/openrefine-socialsciinstructor/instructor-notes.html)                         | **2 hours**       | 
+| [Data Analysis and Visualization in R](https://datacarpentry.org/r-socialsci/)       | [Notes](https://datacarpentry.org/r-socialsciinstructor/instructor-notes.html)                         | **6\.5 hours**       | 
 
 The following workshops are under development:
 

diff --git a/instructors/data.md → learners/data.md b/instructors/data.md → learners/data.md
diff --git a/learners/setup.md → learners/setup.Rmd b/learners/setup.md → learners/setup.Rmd
@@ -2,7 +2,8 @@
 title: Setup
 ---
 
-{% include setup-overview.md %}
+```{r include-setup-overview, child="files/setup-overview.md"}
+```
 
 ## Setup instructions for your workshop
 

diff --git a/setup-python-workshop.Rmd b/setup-python-workshop.Rmd
@@ -0,0 +1,35 @@
+---
+layout: page
+title: Setup for Python workshop
+---
+
+```{r include-setup-overview, child="files/setup-overview.md"}
+```
+
+```{r include-setup-data, child="files/setup-data.md"}
+```
+
+## Software
+
+| Software              | Install                         | Manual | Available for         | Description                                      | 
+| --------------------- | ------------------------------- | ------ | --------------------- | ------------------------------------------------ |
+| Spreadsheet program   | [Download LibreOffice](https://www.libreoffice.org/download/download/)                                | [LibreOffice documentation](https://documentation.libreoffice.org/en/english-documentation/)       | Linux, MacOS, Windows | Spreadsheet program for organizing tabular data. | 
+| OpenRefine            | [Download OpenRefine](https://openrefine.org/download.html)                                | [OpenRefine documentation](https://openrefine.org/docs)       | Linux, MacOS, Windows |                                                  | 
+| Python                | See install instructions below. |        | Linux, MacOS, Windows |                                                  | 
+| DB Browser for SQLite | [Download DB Browser for SQLite](https://sqlitebrowser.org/dl/)                                |        | Linux, MacOS, Windows |                                                  | 
+
+```{r include-setup-spreadsheet, child="files/setup-spreadsheet.md"}
+```
+
+```{r include-setup-openrefine, child="files/setup-openrefine.md"}
+```
+
+```{r include-setup-python, child="files/setup-python.md"}
+```
+
+```{r include-setup-sql, child="files/setup-sql.md"}
+```
+
+Congratulations! You are now ready for the workshop!
+
+
diff --git a/setup-python-workshop.md b/setup-python-workshop.md
diff --git a/setup-r-workshop.Rmd b/setup-r-workshop.Rmd
@@ -0,0 +1,36 @@
+---
+layout: page
+title: Setup for R workshop
+---
+
+```{r include-setup-overview, child="files/setup-overview.md"}
+```
+
+```{r include-setup-data, child="files/setup-data.md"}
+```
+
+## Software
+
+| Software              | Install                         | Manual                | Available for         | Description                                      | 
+| --------------------- | ------------------------------- | --------------------- | --------------------- | ------------------------------------------------ |
+| Spreadsheet program   | [Download LibreOffice](https://www.libreoffice.org/download/download-libreoffice/)                                | [LibreOffice documentation](https://documentation.libreoffice.org/en/english-documentation/)                      | Linux, MacOS, Windows | Spreadsheet program for organizing tabular data. | 
+| OpenRefine            | [Download OpenRefine](https://openrefine.org/download.html)                                | [OpenRefine documentation](https://openrefine.org/docs)                      | Linux, MacOS, Windows |                                                  | 
+| R                     | See install instructions below. |                       | Linux, MacOS, Windows |                                                  | 
+| RStudio               | [Download RStudio](https://posit.co/download/rstudio-desktop/#download)                                | [RStudio Cheatsheet](https://raw.githubusercontent.com/rstudio/cheatsheets/main/rstudio-ide.pdf)                      | Linux, MacOS, Windows |                                                  | 
+| DB Browser for SQLite | [Download DB Browser for SQLite](https://sqlitebrowser.org/dl/)                                | Linux, MacOS, Windows |                       |                                                  | 
+
+```{r include-setup-spreadsheet, child="files/setup-spreadsheet.md"}
+```
+
+```{r include-setup-openrefine, child="files/setup-openrefine.md"}
+```
+
+```{r include-setup-r, child="files/setup-r.md"}
+```
+
+```{r include-setup-sql, child="files/setup-sql.md"}
+```
+
+Congratulations! You are now ready for the workshop!
+
+