Skip to content

Commit

Permalink
uploaded the pdf slides and adjusted the README
Browse files Browse the repository at this point in the history
  • Loading branch information
nevrome committed Jun 19, 2021
1 parent 0d00903 commit a1a1a07
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 14 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@

# rendered output
*.pdf
!rendered_slides/*.pdf
*.html
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
# Developing R Packages

This workshop by the [CAA–SIG Scientific Scripting Languages in Archaeology](https://sslarch.github.io) at [CAA2021, Cyprus](https://2021.caaconference.org) will offer a low-level introduction to R package development. The workshop is complementary to the session
[Tools for the Revolution: developing packages for scientific programming in archaeology](https://github.com/sslarch/caa2021_packages).
This workshop by the [CAA–SIG Scientific Scripting Languages in Archaeology](https://sslarch.github.io) given at [CAA2021, Cyprus](https://2021.caaconference.org) offers a low-level introduction to R package development. The workshop was complementary to the session
[Tools for the Revolution: developing packages for scientific programming in archaeology](https://github.com/sslarch/caa2021_packages) at the conference.

## Feedback form
The slides are available as .pdf in [`rendered_slides`](rendered_slides).

Please, do leave us feedback in here: [https://forms.gle/MzTsMntBxtCCmge1A](https://forms.gle/MzTsMntBxtCCmge1A).
(Or use the issues in this repo, whatever you prefer!)
## What this workshop covers

## What we will do
In this workshop we focused on the main points in Hadley Wickham's book on package development ([Wickham 2020](https://r-pkgs.org)) and created an example application together. Workshop attendees will get to know a structured workflow, which will aid them in organizing their personal scripts afterwards. Main topics include function definition in R, the R package structure and the typical package development cycle. If time allows, we will also introduce topics like vignettes, unit tests or shipping data with packages.

In this workshop we will focus on the main points in Hadley Wickham's book on package development ([Wickham 2020](https://r-pkgs.org)) and create an example application together. Workshop attendees will get to know a structured workflow, which will aid them in organizing their personal scripts afterwards. Main topics include function definition in R, the R package structure and the typical package development cycle. If time allows, we will also introduce topics like vignettes, unit tests or shipping data with packages.
## What you need to code along

## What you have to bring

Basic R knowledge is strongly recommended. Beyond that we ask you to install the following software on the computer you use to participate in the workshop:
Basic R knowledge is strongly recommended. Beyond that you need the following software on the computer you use to participate in the workshop:

- [R](https://cran.rstudio.com/)
- [RStudio Desktop](https://rstudio.com/products/rstudio/download/#download)
Expand All @@ -28,7 +25,3 @@ remotes::install_github("r-lib/devtools")
```

Devtools is also the main package we will need for the workshop.

## Regarding your application "abstract"

CAA2021 does not have a formal workshop category, unfortunately, so we submitted this workshop as a session of type "other". If you want to participate in this workshop, you have to hand in a "paper". Of course this formal requirement is not relevant for a workshop, so we would like to ask you to instead submit some lines about your personal level of experience with R. Then we can adjust the workshop according to your skill level.
6 changes: 6 additions & 0 deletions render_slides.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# render the Rmd files in slides/ to pdf documents in rendered_slides/

Map(
\(x) rmarkdown::render(x, output_dir = "rendered_slides"),
list.files("slides", pattern = ".Rmd", full.names = T)
)
Binary file added rendered_slides/01_slides_intro.pdf
Binary file not shown.
Binary file added rendered_slides/02_slides_functions.pdf
Binary file not shown.
Binary file added rendered_slides/03_slides_Rpackage_structure.pdf
Binary file not shown.
Binary file added rendered_slides/04_slides_documentation.pdf
Binary file not shown.
Binary file added rendered_slides/05_slides_fluffy_context.pdf
Binary file not shown.
Binary file added rendered_slides/06_slides_data.pdf
Binary file not shown.
Binary file added rendered_slides/07_slides_advanced_topics.pdf
Binary file not shown.
Binary file added rendered_slides/08_slides_wrap_up.pdf
Binary file not shown.

0 comments on commit a1a1a07

Please sign in to comment.