rparrish / pointblank-workshop

A workshop to learn lots about the pointblank R package

The pointblank Workshop

This pointblank workshop will teach you a lot about what pointblank can do, and, it'll give you an opportunity to experiment with the package. It's available as an RStudio Cloud project, and that makes it easy to get up and running.

https://rstudio.cloud/content/4726872

The workshop modules will introduce you to a large variety of examples to get you well-acquainted with the basic functionality of the package.

Each module of the workshop focuses on a different subset of functions and they are all presented here as R Markdown (.Rmd) files, with one file for each workshop module:

• "01-intro-to-data-validation.Rmd" (The agent, validation fns, interrogation/reports)

• "02-scan-your-data.Rmd" (Looking at your data with scan_data())

• "03-expect-test-functions.Rmd" (Using the expect_*() and test_*() functions)

• "04-scaling-up-data-validation.Rmd" (The multiagent and its reporting structures)

• "05-intro-to-data-documentation.Rmd" (The informant and describing your data)

• "06-getting-deeper-into-documenting-data.Rmd" (Using snippets and text tricks)

You can navigate to any of these and modify the code within the self-contained R Markdown code chunks. Entire R Markdown files can be knit to HTML, where a separate window will show the rendered document.

The pointblank Installation

Normally you would install pointblank on your system by using install.packages():

install.packages("pointblank")

For this workshop, however, we are going to use the development version of pointblank and install it from GitHub with devtools::install_github().

devtools::install_github("rich-iannone/pointblank")