---

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

```

# Report Student Progress in 'learnitr' Courses <a href="https://learnitr.github.io/learnitprogress/"><img src="man/figures/logo.png" align="right" height="138" /></a>

<!-- badges: start -->

[](https://github.com/learnitr/learnitprogress/actions/workflows/R-CMD-check.yaml)

[](https://app.codecov.io/gh/learnitr/learnitprogress)

[](https://cran.r-project.org/package=learnitprogress)

[](https://learnitr.r-universe.dev/learnitprogress)

[](https://opensource.org/licenses/MIT)

[](https://lifecycle.r-lib.org/articles/stages.html#experimental)

<!-- badges: end -->

A Shiny app that connects to you LRS ("Learning Record Store" database, as created and managed by the 'learnitdown' package) and displays a report showing the completion of exercices and projects. This report is intended for students to track their progress in the course.

## Installation

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

``` r

install.packages("remotes")

```

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

``` r

remotes::install_github("SciViews/learnitprogress")

```

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

## Further explore {learnitprogress}

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

``` r

library("learnitprogress")

```

Get help about this package:

``` r

library(help = "learnitprogress")

help("learnitprogress-package")

vignette("learnitprogress") # None is installed with install_github()

```

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

## Code of Conduct

Please note that the {learnitprogress} 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.