Skip to content

Commit

Permalink
Merge pull request #138 from UMCarpentries/paper
Browse files Browse the repository at this point in the history
Write paper to submit to JOSE
  • Loading branch information
pschloss authored May 21, 2021
2 parents 393f9b1 + 83fbd3a commit cb553cf
Show file tree
Hide file tree
Showing 10 changed files with 577 additions and 13 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/draft-pdf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: paper-pdf

on:
push:
paths:
- paper/*

jobs:
paper:
runs-on: ubuntu-latest
name: Paper Draft
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Build draft PDF
uses: openjournals/openjournals-draft-action@master
with:
journal: jose
# This should be the path to the paper within your repo.
paper-path: paper/paper.md
- name: Upload
uses: actions/upload-artifact@v1
with:
name: paper
# This is the output path where Pandoc will write the compiled
# PDF. Note, this should be the same directory as the input
# paper.md
path: paper/paper.pdf
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ vendor/
.docker-vendor/
Gemfile.lock
.*history
paper/data/
18 changes: 15 additions & 3 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
Kelly Sovacool
Zena Lapp
Patrick Schloss
Maya Lapp
Kelly L. Sovacool
Nick Lesniak
Dana King
Catherine Barnier
Matthew Flickinger
Jule Krüger
Courtney R. Armour
Maya M. Lapp
Jason Tallant
Rucheng Diao
Morgan Oneka
Sarah Tomkovich
Jacqueline Moltzau Anderson
Sarah K. Lucas
Patrick D. Schloss
3 changes: 2 additions & 1 deletion CITATION
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Please cite as:

Schloss et al. "U-M Software Carpentry Custom Curriculum". Nov. 2020, https://github.com/umswc/curriculum
U-M Carpentries: "Introductory Software Carpentry Curriculum with R". Nov. 2020,
https://github.com/umcarpentries/intro-curriculum-r
31 changes: 22 additions & 9 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
---
layout: page
title: "Licenses"
---

The majority of the instructional material and code in this repository is
new, original work created by the U-M Carpentries instance and is made available
under the licenses described below.
Parts of some of the material and code are inspired by or derived from Software
Carpentry lessons with substantial modifications, which are Copyright © Software
Carpentry under the [Creative Commons Attribution][cc-by-human] and
[MIT][mit-license] licenses.
The scaffolding of this repository is derived from
[The Carpentries Lesson Example](https://github.com/carpentries/lesson-example);
their material and code are also made available under the
[CC BY 4.0 and MIT licenses](https://github.com/carpentries/lesson-example/blob/gh-pages/LICENSE.md).

## Instructional Material

All Software Carpentry, Data Carpentry, and Library Carpentry instructional material is
All U-M Carpentries instructional material is
made available under the [Creative Commons Attribution
license][cc-by-human]. The following is a human-readable summary of
(and not a substitute for) the [full legal text of the CC BY 4.0
Expand All @@ -21,13 +35,12 @@ license terms.

Under the following terms:

* **Attribution**---You must give appropriate credit (mentioning that
your work is derived from work that is Copyright © Software
Carpentry and, where practical, linking to
http://software-carpentry.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.
* **Attribution**---You must give appropriate credit (mentioning that your work
is derived from work that is Copyright © U-M Carpentries and, where practical,
linking to https://umcarpentries.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
technological measures that legally restrict others from doing
Expand All @@ -46,7 +59,7 @@ Notices:
## Software

Except where otherwise noted, the example programs and other software
provided by Software Carpentry and Data Carpentry are made available under the
provided by U-M Carpentries are made available under the
[OSI][osi]-approved
[MIT license][mit-license].

Expand Down
Binary file added paper/curriculum-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added paper/development-framework.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
94 changes: 94 additions & 0 deletions paper/paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@

@misc{becker_responding_2016,
title = {Responding to Your {{Learners}}},
author = {Becker, Erin},
year = {2016},
month = sep,
abstract = {Data Carpentry is a lesson program of The Carpentries that develops and provides data skills training to researchers.},
howpublished = {https://datacarpentry.org/blog/2016/09/formative-assessment},
journal = {Data Carpentry},
language = {en}
}

@misc{chen_online_2020,
title = {Online {{Workshop Logistics}} and {{Screen Layouts}}},
author = {Chen, Daniel},
year = {2020},
month = jun,
abstract = {Online workshop logistics and how learners would set up their screens if they only had a single monitor.},
howpublished = {https://carpentries.org/blog/2020/06/online-workshop-logistics-and\_screen-layouts/},
journal = {The Carpentries},
language = {en}
}

@misc{robinson_teach_2017,
title = {Teach the Tidyverse to Beginners},
author = {Robinson, David},
year = {2017},
month = jul,
abstract = {A few years ago, I wrote a post Don't teach built-in plotting to beginners (teach ggplot2). I argued that ggplot2 was not an advanced approach meant for experts, but rather a suitable introduction to data visualization.},
howpublished = {http://varianceexplained.org/r/teach-tidyverse/},
journal = {Variance Explained},
language = {en}
}

@misc{the_carpentries_carpentries_2018,
title = {The {{Carpentries Handbook}}},
author = {{The Carpentries}},
year = {2018},
howpublished = {https://docs.carpentries.org/index.html}
}

@misc{the_carpentries_live_2018,
title = {Live {{Coding}} Is a {{Skill}}},
author = {{The Carpentries}},
year = {2018},
howpublished = {https://carpentries.github.io/instructor-training/14-live/\#sticky-notes},
journal = {Instructor Training},
language = {en}
}

@article{wickham_welcome_2019,
title = {Welcome to the {{Tidyverse}}},
author = {Wickham, Hadley and Averick, Mara and Bryan, Jennifer and Chang, Winston and McGowan, Lucy and Fran{\c c}ois, Romain and Grolemund, Garrett and Hayes, Alex and Henry, Lionel and Hester, Jim and Kuhn, Max and Pedersen, Thomas and Miller, Evan and Bache, Stephan and M{\"u}ller, Kirill and Ooms, Jeroen and Robinson, David and Seidel, Dana and Spinu, Vitalie and Takahashi, Kohske and Vaughan, Davis and Wilke, Claus and Woo, Kara and Yutani, Hiroaki},
year = {2019},
month = nov,
volume = {4},
pages = {1686},
issn = {2475-9066},
doi = {10.21105/joss.01686},
file = {/Volumes/GoogleDrive/My Drive/Zotero/storage/JXLZ6VKP/Wickham et al. - 2019 - Welcome to the Tidyverse.pdf;/Volumes/GoogleDrive/My Drive/Zotero/storage/TDQ3CKIW/joss.html},
journal = {Journal of Open Source Software},
language = {en},
number = {43}
}

@article{wilson_software_2016,
title = {Software {{Carpentry}}: Lessons Learned},
shorttitle = {Software {{Carpentry}}},
author = {Wilson, Greg},
year = {2016},
month = jan,
volume = {3},
pages = {62},
issn = {2046-1402},
doi = {10.12688/f1000research.3-62.v2},
abstract = {Since its start in 1998, Software Carpentry has evolved from a~week-long training course at the US national laboratories into a~worldwide volunteer effort to improve researchers' computing~skills. This paper explains what we have learned along the way, the~challenges we now face, and our plans for the future.},
file = {/Volumes/GoogleDrive/My Drive/Zotero/storage/X4KASHTT/Wilson_2016_F1000Res.pdf},
journal = {F1000Res},
keywords = {Software Carpentry},
language = {en}
}

@book{xie_r_2018,
title = {R {{Markdown}}: {{The Definitive Guide}}},
shorttitle = {R {{Markdown}}},
author = {Xie, Yihui and Allaire, J. J. and Grolemund, Garrett},
year = {2018},
publisher = {{Taylor \& Francis, CRC Press}},
abstract = {R Markdown: The Definitive Guide is the first official book authored by the core R Markdown developers that provides a comprehensive and accurate reference to the R Markdown ecosystem. With R Markdown, you can easily create reproducible data analysis reports, presentations, dashboards, interactive applications, books, dissertations, websites, and journal articles, while enjoying the simplicity of Markdown and the great power of R and other languages. In this book, you will learn Basics: Syntax of Markdown and R code chunks, how to generate figures and tables, and how to use other computing languages Built-in output formats of R Markdown: PDF/HTML/Word/RTF/Markdown documents and ioslides/Slidy/Beamer/PowerPoint presentations Extensions and applications: Dashboards, Tufte handouts, xaringan/reveal.js presentations, websites, books, journal articles, and interactive tutorials Advanced topics: Parameterized reports, HTML widgets, document templates, custom output formats, and Shiny documents. Yihui Xie is a software engineer at RStudio. He has authored and co-authored several R packages, including knitr, rmarkdown, bookdown, blogdown, shiny, xaringan, and animation. He has published three other books, Dynamic Documents with R and knitr, bookdown: Authoring Books and Technical Documents with R Markdown, and blogdown: Creating Websites with R Markdown. J.J. Allaire is the founder of RStudio and the creator of the RStudio IDE. He is an author of several packages in the R Markdown ecosystem including rmarkdown, flexdashboard, learnr, and radix. Garrett Grolemund is the co-author of R for Data Science and author of Hands-On Programming with R. He wrote the lubridate R package and works for RStudio as an advocate who trains engineers to do data science with R and the Tidyverse.},
isbn = {978-1-138-35933-8},
language = {English}
}


Loading

0 comments on commit cb553cf

Please sign in to comment.