-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
68 lines (43 loc) · 2.4 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# NHSRtraining <a alt="NHS-R Community's logo" href='https://nhsrcommunity.com/'><img src='https://nhs-r-community.github.io/assets/logo/nhsr-logo.png' align="right" height="80" /></a>
<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->
## Goal
The goal of `NHSRtraining` is to supplement the NHSR [Introduction to R and R Studio training](https://nhs-r-community.github.io/intro_r/) and the [GitHub repository](https://github.com/nhs-r-community/intro_r) with exercises that can be completed as part of the course or
## Installation
You can install the development version of NHSRtraining from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("nhs-r-community/NHSRtraining")
```
Currently the [{parsons} package](https://github.com/rstudio/parsons) is not available on CRAN. This is used to create some of the interactivity of the quiz questions where answers can me moved from one side to another into order. To load this:
``` r
# install.packages("remotes")
remotes::install_github("rstudio/parsons")
```
## Running the tutorials
Unlike with usual packages where `library(NHSRtraining)` would be used, this package uses `learnr` so, once the package is installed, the following code details what is available:
```{r, eval=FALSE}
learnr::available_tutorials("NHSRtraining")
```
and running each tutorial:
```{r, eval=FALSE}
learnr::run_tutorial("list-tutorial-name", package = "NHSRtraining")
```
## Thanks and credits
This package has been greatly inspired in its structure from other "box" training like [Penguins in a box](https://github.com/demar01/penguinsbox) (in both English and Spanish) and [Data Science in a Box](https://datasciencebox.org/).
Materials used to build the package are from the Forwards workshop: [Packages in a nutshell](https://github.com/forwards/workshops/tree/dc5b9fba5cdfbebc737a0a393b374a18378be122).
## Comments or Issues
If you have any comments or notice any errors, please create an [issue](https://github.com/nhs-r-community/NHSRtraining/issues).