learnitdown/README.Rmd at main · learnitr/learnitdown · GitHub

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%")
```

# learnitdown - R Markdown, Bookdown and Learnr Additions for Learning Material <a href="https://learnitr.github.io/learnitdown/"><img src="man/figures/logo.png" align="right" height="138" /></a>

<!-- badges: start -->

[![R-CMD-check](https://github.com/learnitr/learnitdown/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/learnitr/learnitdown/actions/workflows/R-CMD-check.yaml)
[[![codecov](https://codecov.io/gh/learnitr/learnitdown/graph/badge.svg?token=1YyLPD4HkZ)](https://app.codecov.io/gh/learnitr/learnitdown)
[![CRAN Status](https://www.r-pkg.org/badges/version/learnitdown)](https://cran.r-project.org/package=learnitdown)
[![r-universe status](https://learnitr.r-universe.dev/badges/learnitdown)](https://learnitr.r-universe.dev/learnitdown)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Lifecycle stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->

Use R Markdown and {bookdown} to build e-learning material with h5p, differed loading of {Shiny} and {learnr} applications, course-specific content, and much more...

## Installation

(Not yet! The latest stable version of {learnitdown} can simply be installed from [CRAN](http://cran.r-project.org):)

``` r
install.packages("learnitdown")
```

You can also install the latest development version. Make sure you have the {remotes} R package installed:

``` r
install.packages("remotes")
```

Use `install_github()` to install the {learnitdown} package from GitHub (source from **master** branch will be recompiled on your machine):

``` r
remotes::install_github("SciViews/learnitdown")
```

R should install all required dependencies automatically, and then it should compile and install {learnitdown}.

## Further explore {learnitdown}

You can get further help about this package this way. Make the {learnitdown} package available in your R session:

``` r
library("learnitdown")
```

Get help about this package:

``` r
library(help = "learnitdown")
help("learnitdown-package")
vignette("learnitdown") # None is installed with install_github()
```

For further instructions, please, refer to these help pages at <https://learnitr.github.io/learnitdown/>.

## Code of Conduct

Please note that the {learnitdown} package is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.