diff --git a/.Rbuildignore b/.Rbuildignore index 91114bf..4183b85 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,8 @@ ^.*\.Rproj$ ^\.Rproj\.user$ +.travis.yml +_pkgdown.yaml +appveyor.yml +index.Rmd +logo.* +LICENSE \ No newline at end of file diff --git a/.gitignore b/.gitignore index 0a74739..75d9756 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ src/*.o src/*.so src/*.dll +.DS_STORE \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..2238f6e --- /dev/null +++ b/.travis.yml @@ -0,0 +1,58 @@ +language: R +sudo: false +cran: http://cran.rstudio.com +cache: packages +warnings_are_errors: false +os: + - linux + - osx + +r_build_args: "--no-manual --no-build-vignettes" +r_check_args: "--as-cran --ignore-vignettes --no-examples --install-args=--build" + +before_install: + - fname=travis_helpers.sh + - wget -O ${fname} http://bit.ly/travis_helpers + - cat ${fname}; source ${fname}; rm ${fname} + - cat DESCRIPTION + - export PACKAGE_NAME=`package_name` + - export RCHECK_DIR=${PACKAGE_NAME}.Rcheck + +after_success: + - cat ${RCHECK_DIR}/00install.out + - cat ${RCHECK_DIR}/00check.log + +after_failure: + - cat ${RCHECK_DIR}/00install.out + - cat ${RCHECK_DIR}/00check.log + +before_deploy: + - if [ "$TRAVIS_OS_NAME" = "osx" ]; + then + PKG_TARBALL=$(ls -1t *.tgz | head -n 1); + PKG_TARBALL_WITH_R=`echo $PKG_TARBALL | sed 's/.tgz/_'"R${rver}"'.tgz/'` ; + mv ${PKG_TARBALL} ${PKG_TARBALL_WITH_R} ; + echo "Built tarball is ${PKG_TARBALL_WITH_R}" ; + fi + - if [ "$TRAVIS_OS_NAME" = "linux" ]; + then + PKG_TARBALL=$(ls -1t *.tar.gz | head -n 1); + PKG_TARBALL_WITH_R=`echo $PKG_TARBALL | sed 's/.tar.gz/_'"R${rver}"'.tar.gz/'` ; + mv ${PKG_TARBALL} ${PKG_TARBALL_WITH_R} ; + echo "Built tarball is ${PKG_TARBALL_WITH_R}" ; + fi + - if [[ "${TRAVIS_OS_NAME}" = "osx" ]]; + then + rm -f *.tar.gz; + fi + +deploy: + provider: releases + skip_cleanup: true + api_key: + secure: pVFJPm5rdLijONI/LaVsoaUH0jUJm2DfRROO2RoQanpRWGK+3r56ZcE/lgFGiCjmKigQhbDVY6ld/6Zt9ODI7pNFlu5fuSd4nGjY3RNjXO82kNCTHMHD79NGfHriHRzuAkjV/ahs7Vzotr3G9CMjwT1cgTqwJ4K03zoenZfZlRq4UzqLbaTaUn1z1UMZEFP1s4rP3/KTNwCbDxXkPSE6WDVtO+k4oCxKz5saLWkshrbcyBY409KLZgNpjIiHFWdUEFyUqMV9mFZkwH3duIbNQlFLK1IietHgmed4In1jr5JuyMH53aqDyE7zwxZPVR+Ct/3Zs6hRgVZrPHl9edMX+UdUXz5RES5efGOM/uvOle3F3tTMLj3f2iR7QlJ8KA/LXI97mmpJo47OT/2KhJHZNw6tmHDMhcAhnT3HPGgZkUMKToMqUGL3DUcuZO0IZ4I34BkBuuxVWO5GNcOEi/HwAKpD/d1Pww7eMlPzr5lnqpjZYMcqp+dtiNT6TFnM39gLVViIDTTSmr7uosNq6n0XAt3JhS/MkoQHSxz1bAaDXNu8ZVsQsW1EiujfWDz6gYd553RpCClaVYxNUC2bqXVtLuZMcT1afjx8Z5alPMJArXZELhv/TfjvwHB4hivj/6zlmS1SknNgoLwfQD66SC9j5b76r/VhTGHKDMkDDaGPMLw= + file_glob: true + file: ${PACKAGE_NAME}*.t*gz + on: + repo: swarm-lab/${PACKAGE_NAME} + tags: true diff --git a/DESCRIPTION b/DESCRIPTION index 8bcb898..a42873b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,14 +1,28 @@ Package: teachR Type: Package -Title: TODO -Version: 0.1 -Date: 2015-05-13 -Author: Simon Garnier +Title: R Package For Distributing Web Applications For Educational Use +Version: 0.2 +Authors@R: c( + person("Simon", "Garnier", email = "garnier@njit.edu", role = c("aut", "cre"), + comment = c(ORCID = "0000-0002-3886-3974")) + ) Maintainer: Simon Garnier -Description: TODO -License: GPL (>= 3) +Description: teachR is a package for R that bundles several Shiny web + applications for educational use. The goal of teachR is to provide teachers + and educators with free, easy-to-use and interactive applications for + complementing their courses with virtual demonstrations and/or experiments. +License: GPL-3 Imports: - shiny (>= 0.11.1), - pacman (>= 0.4.1), - shinythemes (>= 1.1.1) -RoxygenNote: 5.0.1 + shiny (>= 1.2.0), + pacman (>= 0.5.0), + shinythemes (>= 1.1.2), + dplyr (>= 0.7.8), + markdown (>= 0.9), + mime (>= 0.6) +Suggests: + knitr +VignetteBuilder: knitr +URL: https://swarm-lab.github.io/teachR/, https://github.com/swarm-lab/teachR +BugReports: https://github.com/swarm-lab/teachR/issues +RoxygenNote: 6.1.1 +Encoding: UTF-8 diff --git a/R/export_app.R b/R/export_app.R index 0cdf98c..9821e28 100644 --- a/R/export_app.R +++ b/R/export_app.R @@ -1,25 +1,26 @@ -#' @title Export \code{\link[:-package]{teachR}} Apps +#' @title Export \code{teachR} Apps #' -#' @description This function expor a Shiny app provided by the -#' \code{\link[:-package]{teachR}} library to a local folder on +#' @description This function exports a Shiny app provided by the +#' \code{teachR} library to a local folder on #' a user's computer. Useful for modifying the app or running it on a Shiny #' Server instance for example. #' -#' @param app The name of the app to run. +#' @param app The name of the app to export. #' #' @param dest The destination of the app folder on the user's computer. A folder -#' with the name of the app will be created at this location. +#' with the name of the app will be created at this location. #' #' @return This function does not return anything. #' -#' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} -#' +#' @author Simon Garnier, \email{garnier@@njit.edu} +#' #' @examples -#' # Export app to the current working directory -#' export_app("aggregation_segregation", ".") +#' \dontrun{ +#' # Export app to the current working directory +#' export_app("aggregation_segregation", ".") +#' } #' #' @export -#' export_app <- function(app, dest) { app_path <- paste0(find.package("teachR"), "/apps/", app) file.copy(from = app_path, to = dest, recursive = TRUE) diff --git a/R/list_apps.R b/R/list_apps.R index 502c6bf..5c12195 100644 --- a/R/list_apps.R +++ b/R/list_apps.R @@ -1,36 +1,37 @@ -#' @title List \code{\link[:-package]{teachR}} Apps +#' @title List \code{teachR} Apps #' #' @description This function generates a webpage listing all the apps available -#' through the \code{\link[:-package]{teachR}} library. The -#' list can be filtered by category (type \code{list_categories()} for a list -#' of existing categories) and keywords (type \code{list_keywords()} for a list -#' of existing keywords). +#' through the \code{teachR} library. The list can be filtered by category +#' (type \code{list_categories()} for a list of existing categories) and +#' keywords (type \code{list_keywords()} for a list of existing keywords). #' #' @param categories A character string or a vector of character strings -#' corresponding to existing app categories (case insensitive). +#' corresponding to existing app categories (case insensitive). #' #' @param keywords A character string or a vector of character strings -#' corresponding to existing app keywords (case insensitive). +#' corresponding to existing app keywords (case insensitive). #' #' @return This function opens an html file. #' -#' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} +#' @author Simon Garnier, \email{garnier@@njit.edu} #' #' @details If called from RStudio, the list will open in the internal RStudio -#' viewer. If called from a terminal, it will open in your default internet browser. +#' viewer. If called from a terminal, it will open in your default internet +#' browser. #' #' @examples -#' list_apps(categories = c("biology", "social science")) +#' \dontrun{ +#' list_apps(categories = c("biology", "social science")) +#' } #' #' @export -#' list_apps <- function(categories=NULL, keywords=NULL) { apps <- dir(paste0(find.package("teachR"), "/apps")) info_table <- data.frame() for (i in 1:length(apps)) { - info <- read.table(paste0(find.package("teachR"), "/apps/", apps[i], "/info"), sep = ":") - info <- t(as.matrix(info)[,2]) + info <- utils::read.table(paste0(find.package("teachR"), "/apps/", apps[i], "/info"), sep = ":") + info <- t(as.matrix(info)[, 2]) info_table <- rbind(info_table, info) } info_table[] <- lapply(info_table, as.character) @@ -41,10 +42,10 @@ list_apps <- function(categories=NULL, keywords=NULL) { md <- .make_list(info_table, categories, keywords) tmp_file <- tempfile(pattern = "file", fileext = ".html") - out <- knit(text = md) - .markdownToHTML(text = out, output = tmp_file, options = c("toc"), - title = "Apps available in teachR", - template = paste0(find.package("teachR"), "/html/template.html")) + out <- knitr::knit(text = md) + markdown::markdownToHTML(text = out, output = tmp_file, options = c("toc"), + title = "Apps available in teachR", + template = paste0(find.package("teachR"), "/html_templates/template.html")) viewer <- getOption("viewer") if (!is.null(viewer)) @@ -55,22 +56,18 @@ list_apps <- function(categories=NULL, keywords=NULL) { .index <- function(x, pattern) { - pattern <- paste(tolower(pattern), collapse= "|") + pattern <- paste(tolower(pattern), collapse = "|") x <- tolower(x) grepl(pattern, x) } .make_list <- function(info_table, categories = NULL, keywords = NULL) { - require(dplyr) - require(knitr) - require(markdown) - if (!is.null(categories)) { - info_table <- filter(info_table, .index(Category, categories)) + info_table <- dplyr::filter(info_table, .index(Category, categories)) } if (!is.null(keywords)) { - info_table <- filter(info_table, .index(Keywords, keywords)) + info_table <- dplyr::filter(info_table, .index(Keywords, keywords)) } if (nrow(info_table) > 0) { @@ -81,7 +78,7 @@ list_apps <- function(categories=NULL, keywords=NULL) { category <- sub(" ", "", categories[i]) md <- c(md, paste0("### ", category)) - tmp <- filter(info_table, .index(Category, categories[i])) + tmp <- dplyr::filter(info_table, .index(Category, categories[i])) for (j in 1:nrow(tmp)) { md <- c(md, "") @@ -126,81 +123,80 @@ list_apps <- function(categories=NULL, keywords=NULL) { } -.markdownToHTML <- function(file, output = NULL, text = NULL, options = getOption("markdown.HTML.options"), - extensions = getOption("markdown.extensions"), title = "", - stylesheet = getOption("markdown.HTML.stylesheet"), - header = getOption("markdown.HTML.header"), - template = getOption("markdown.HTML.template"), fragment.only = FALSE, - encoding = getOption("encoding")) { - if (fragment.only) - options <- c(options, "fragment_only") - ret <- renderMarkdown(file, output = NULL, text, renderer = "HTML", - renderer.options = options, extensions = extensions, - encoding = encoding) - ret <- enc2native(ret) - if ("base64_images" %in% options) { - filedir <- if (!missing(file) && is.character(file) && - file.exists(file)) { - dirname(file) - } - else "." - ret <- local({ - oldwd <- setwd(filedir) - on.exit(setwd(oldwd)) - .b64EncodeImages(ret) - }) - } - if (!"fragment_only" %in% options) { - if (is.null(template)) - template <- system.file("resources", "markdown.html", - package = "markdown") - html <- paste(readLines(template), collapse = "\n") - html <- sub("#!html_output#", ret, html, fixed = TRUE) - if (is.character(stylesheet)) { - html <- sub("#!markdown_css#", markdown:::option2char(stylesheet), - html, fixed = TRUE) - } - else { - warning("stylesheet must either be valid CSS or a file containing CSS!") - } - html <- sub("#!header#", markdown:::option2char(header), html, fixed = TRUE) - if (!is.character(title) || title == "") { - m <- regexpr("<[Hh][1-6].*?>(.*)", - html, perl = TRUE) - if (m > -1) { - title <- regmatches(html, m) - title <- sub("<[Hh][1-6].*?>", "", title) - title <- sub("", "", title) - } - else { - title <- "" - } - } - html <- gsub("#!title#", title, html, fixed = TRUE) - if ("mathjax" %in% options && .requiresMathJax(html)) { - mathjax <- .mathJax(embed = "mathjax_embed" %in% - options) - } - else mathjax <- "" - html <- sub("#!mathjax#", mathjax, html, fixed = TRUE) - if ("highlight_code" %in% options && .requiresHighlighting(html)) { - highlight <- paste(readLines(system.file("resources", - "r_highlight.html", package = "markdown")), collapse = "\n") - } - else highlight <- "" - html <- sub("#!r_highlight#", highlight, html, fixed = TRUE) - ret <- html - } - if (is.character(output)) { - ret2 <- iconv(ret, to = "UTF-8") - if (any(is.na(ret2))) { - warning("failed to convert output to UTF-8; wrong input encoding or locale?") - } - else ret <- ret2 - writeLines(ret, output, useBytes = TRUE) - ret <- NULL - } - invisible(ret) -} - - +# .markdownToHTML <- function(file, output = NULL, text = NULL, +# options = getOption("markdown.HTML.options"), +# extensions = getOption("markdown.extensions"), title = "", +# stylesheet = getOption("markdown.HTML.stylesheet"), +# header = getOption("markdown.HTML.header"), +# template = getOption("markdown.HTML.template"), fragment.only = FALSE, +# encoding = getOption("encoding")) { +# if (fragment.only) +# options <- c(options, "fragment_only") +# ret <- markdown::renderMarkdown(file, output = NULL, text, renderer = "HTML", +# renderer.options = options, extensions = extensions, +# encoding = encoding) +# ret <- enc2native(ret) +# if ("base64_images" %in% options) { +# filedir <- if (!missing(file) && is.character(file) && +# file.exists(file)) { +# dirname(file) +# } +# else "." +# ret <- local({ +# oldwd <- setwd(filedir) +# on.exit(setwd(oldwd)) +# .b64EncodeImages(ret) +# }) +# } +# if (!"fragment_only" %in% options) { +# if (is.null(template)) +# template <- system.file("resources", "markdown.html", +# package = "markdown") +# html <- paste(readLines(template), collapse = "\n") +# html <- sub("#!html_output#", ret, html, fixed = TRUE) +# if (is.character(stylesheet)) { +# html <- sub("#!markdown_css#", option2char(stylesheet), +# html, fixed = TRUE) +# } +# else { +# warning("stylesheet must either be valid CSS or a file containing CSS!") +# } +# html <- sub("#!header#", option2char(header), html, fixed = TRUE) +# if (!is.character(title) || title == "") { +# m <- regexpr("<[Hh][1-6].*?>(.*)", +# html, perl = TRUE) +# if (m > -1) { +# title <- regmatches(html, m) +# title <- sub("<[Hh][1-6].*?>", "", title) +# title <- sub("", "", title) +# } +# else { +# title <- "" +# } +# } +# html <- gsub("#!title#", title, html, fixed = TRUE) +# if ("mathjax" %in% options && .requiresMathJax(html)) { +# mathjax <- .mathJax(embed = "mathjax_embed" %in% +# options) +# } +# else mathjax <- "" +# html <- sub("#!mathjax#", mathjax, html, fixed = TRUE) +# if ("highlight_code" %in% options && .requiresHighlighting(html)) { +# highlight <- paste(readLines(system.file("resources", +# "r_highlight.html", package = "markdown")), collapse = "\n") +# } +# else highlight <- "" +# html <- sub("#!r_highlight#", highlight, html, fixed = TRUE) +# ret <- html +# } +# if (is.character(output)) { +# ret2 <- iconv(ret, to = "UTF-8") +# if (any(is.na(ret2))) { +# warning("failed to convert output to UTF-8; wrong input encoding or locale?") +# } +# else ret <- ret2 +# writeLines(ret, output, useBytes = TRUE) +# ret <- NULL +# } +# invisible(ret) +# } diff --git a/R/list_categories.R b/R/list_categories.R index 050f161..f0a2e58 100644 --- a/R/list_categories.R +++ b/R/list_categories.R @@ -1,26 +1,26 @@ -#' @title List Categories of All \code{\link[:-package]{teachR}} Apps +#' @title List Categories of All \code{teachR} Apps #' #' @description This function generates a listing of all the categories of apps -#' available through the \code{\link[:-package]{teachR}} -#' library. +#' available through the \code{teachR} library. #' #' @return A vector of character strings, each of them corresponding to a different -#' category. +#' category. #' -#' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} +#' @author Simon Garnier, \email{garnier@@njit.edu} #' #' @examples -#' list_categories() +#' \dontrun{ +#' list_categories() +#' } #' #' @export -#' list_categories <- function() { apps <- dir(paste0(find.package("teachR"), "/apps")) info_table <- data.frame() for (i in 1:length(apps)) { - info <- read.table(paste0(find.package("teachR"), "/apps/", apps[i], "/info"), sep = ":") - info <- t(as.matrix(info)[,2]) + info <- utils::read.table(paste0(find.package("teachR"), "/apps/", apps[i], "/info"), sep = ":") + info <- t(as.matrix(info)[, 2]) info_table <- rbind(info_table, info) } info_table[] <- lapply(info_table, as.character) @@ -32,7 +32,3 @@ list_categories <- function() { categories <- sort(unique(unlist(categories))) sub(" ", "", categories) } - - - - diff --git a/R/list_keywords.R b/R/list_keywords.R index 03c3a0d..e8b5f3b 100644 --- a/R/list_keywords.R +++ b/R/list_keywords.R @@ -1,26 +1,26 @@ -#' @title List Keywords of All \code{\link[:-package]{teachR}} Apps +#' @title List Keywords of All \code{teachR} Apps #' #' @description This function generates a listing of all the keywords of apps -#' available through the \code{\link[:-package]{teachR}} -#' library. +#' available through the \code{teachR} library. #' #' @return A vector of character strings, each of them corresponding to a different -#' keyword. +#' keyword. #' -#' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier} +#' @author Simon Garnier, \email{garnier@@njit.edu} #' #' @examples -#' list_keywords() +#' \dontrun{ +#' list_keywords() +#' } #' #' @export -#' list_keywords <- function() { apps <- dir(paste0(find.package("teachR"), "/apps")) info_table <- data.frame() for (i in 1:length(apps)) { - info <- read.table(paste0(find.package("teachR"), "/apps/", apps[i], "/info"), sep = ":") - info <- t(as.matrix(info)[,2]) + info <- utils::read.table(paste0(find.package("teachR"), "/apps/", apps[i], "/info"), sep = ":") + info <- t(as.matrix(info)[, 2]) info_table <- rbind(info_table, info) } info_table[] <- lapply(info_table, as.character) diff --git a/R/markdown.R b/R/markdown.R new file mode 100644 index 0000000..37ad134 --- /dev/null +++ b/R/markdown.R @@ -0,0 +1,79 @@ +#' # Functions copied from the markdown package +#' .mathJax <- local({ +#' js <- NULL +#' +#' function(embed=FALSE, force=FALSE) { +#' if (!embed) +#' return(paste(readLines(system.file( +#' 'resources', 'mathjax.html', package = 'markdown' +#' )), collapse = '\n')) +#' +#' url <- 'https://cdn.bootcss.com/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML' +#' +#' # Insert or link to MathJax script? +#' html <- c('', if (embed) { +#' # Already in cache? +#' if (force || is.null(js)) { +#' js <<- readLines(url, warn = FALSE) +#' } +#' c('') +#' +#' paste(html, collapse = "\n") +#' } +#' }) +#' +#' +#' .requiresMathJax <- function(html) { +#' regs <- c("\\\\\\(([\\s\\S]+?)\\\\\\)", "\\\\\\[([\\s\\S]+?)\\\\\\]") +#' for (i in regs) if (any(grepl(i, html, perl = TRUE))) +#' return(TRUE) +#' FALSE +#' } +#' +#' .requiresHighlighting <- function(html) { +#' any(grepl("
:-package]{teachR}} Apps
+#' @title Run \code{teachR} Apps
 #'
 #' @description This function calls a Shiny app provided by the 
-#'  \code{\link[:-package]{teachR}} library. The list of 
-#'  available Shiny apps can be obtained by typing \code{list_apps()} in your R 
-#'  terminal. 
+#'  \code{teachR} library. The list of available Shiny apps can be obtained by 
+#'  typing \code{list_apps()} in your R terminal. 
 #' 
 #' @param app The name of the app to run.
 #' 
 #' @return This function does not return anything.
 #' 
-#' @author Simon Garnier: \email{garnier@@njit.edu}, \link[https://twitter.com/sjmgarnier]{@@sjmgarnier}
+#' @author Simon Garnier, \email{garnier@@njit.edu}
 #' 
 #' @details If called from RStudio, the app will open in the internal RStudio 
-#' internet browser. If called from a terminal, it will open in your default 
-#' internet browser. All apps should work without any problem with the internal 
-#' RStudio internet browser, as well as with recent versions of most internet 
-#' browsers. It is likely to break with older versions.
+#'  internet browser. If called from a terminal, it will open in your default 
+#'  internet browser. All apps should work without any problem with the internal 
+#'  RStudio internet browser, as well as with recent versions of most internet 
+#'  browsers. It is likely to break with older versions.
 #' 
 #' @examples
-#' run_app("aggregation_segregation")
+#' \dontrun{
+#'  run_app("aggregation_segregation")
+#' }
 #' 
 #' @export
-#'
 run_app <- function(app) {
-  require(shiny)
   app_path <- paste0(find.package("teachR"), "/apps/", app)
-  runApp(app_path)
+  shiny::runApp(app_path)
 }
 
diff --git a/README.md b/README.md
index 6ee97d0..2c77a8a 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,14 @@
-teachR
-======
+# teachR - R package for distributing web applications for educational use 
+
+[![Travis-CI Build Status](https://travis-ci.org/swarm-lab/teachR.svg?branch=master)](https://travis-ci.org/swarm-lab/teachR)
+[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/swarm-lab/teachR?branch=master&svg=true)](https://ci.appveyor.com/project/swarm-lab/teachR)
+
+**Please submit all suggestions and bug reports 
+[here](https://github.com/swarm-lab/teachR/issues). Thanks!**
+
+---
+
+## Description 
 
 `teachR` is a package for [`R`](http://www.r-project.org) that bundles several 
 [`Shiny`](http://shiny.rstudio.com/) web applications for educational use. 
@@ -16,8 +25,8 @@ on [`shinyapp.io`](https://www.shinyapps.io/) or on a personal
 
 The `teachR` package is at a very early stage of development. It contains only a 
 few [`Shiny`](http://shiny.rstudio.com/) applications at the moment, but this 
-number is meant to grow with the help [`Shiny`](http://shiny.rstudio.com/) 
-developers willing to make their educational web applications more easily 
+number is meant to grow with the help of [`Shiny`](http://shiny.rstudio.com/) 
+developers looking to make their educational web applications more easily 
 accessible. 
 
 If you are a [`Shiny`](http://shiny.rstudio.com/) developer and want to 
@@ -27,24 +36,10 @@ send me a pull request.
 
 ---
 
-#### Installation
-Installing `teachR` from this GitHub repository is pretty straightforward: 
-simply copy the following lines of code in your R terminal: 
+## Quick start guides
 
-```{r}
-if (!require("devtools")) install.packages("devtools")
-devtools::install_github("swarm-lab/teachR")
-
-library(teachR)
-```
-
-Use the package's help to learn how to discover and run the applications provided
-in `teachR`. 
+1. [Installing teachR](https://swarm-lab.github.io/teachR/articles/z1_install)
+2. [Using teachR](https://swarm-lab.github.io/ROpenCVLite/articles/z2_usage.html)
+3. [Adding new apps to teachR](https://swarm-lab.github.io/ROpenCVLite/articles/z3_participate.html)
 
 ---
-
-#### Maintainer(s)
-Simon Garnier - [@sjmgarnier](https://twitter.com/sjmgarnier) - 
-
-
----
\ No newline at end of file
diff --git a/_pkgdown.yaml b/_pkgdown.yaml
new file mode 100644
index 0000000..79c81ea
--- /dev/null
+++ b/_pkgdown.yaml
@@ -0,0 +1,15 @@
+url: https://swarm-lab.github.io/teachR/
+
+template:
+  params:
+    bootswatch: yeti
+#    docsearch:
+#      api_key: 3a2946bbe34c635ad2e2aae74a83374b
+#      index_name: swarm-lab-swarm
+
+authors:
+  Simon Garnier:
+    href: http://www.theswarmlab.com
+
+development:
+  mode: unreleased
diff --git a/appveyor.yml b/appveyor.yml
new file mode 100644
index 0000000..a4aaa5e
--- /dev/null
+++ b/appveyor.yml
@@ -0,0 +1,59 @@
+# DO NOT CHANGE
+init:
+  ps: |
+    $ErrorActionPreference = "Stop"
+    Invoke-WebRequest http://raw.github.com/krlmlr/r-appveyor/master/scripts/appveyor-tool.ps1 -OutFile "..\appveyor-tool.ps1"
+    Import-Module '..\appveyor-tool.ps1'
+
+install:
+  ps: Bootstrap
+
+cache:
+  - C:\RLibrary
+
+
+# Adapt as necessary starting from here
+environment:
+  global:
+    WARNINGS_ARE_ERRORS: 0.0
+    USE_RTOOLS: yes
+    R_CHECK_INSTALL_ARGS: --install-args=--build
+
+  matrix:
+  - R_VERSION: stable
+    RTOOLS_VERSION: 34
+    CRAN: http://cran.rstudio.com
+
+build_script:
+  - travis-tool.sh install_deps
+
+test_script:
+  - travis-tool.sh run_tests
+
+on_failure:
+  - 7z a failure.zip *.Rcheck\*
+  - appveyor PushArtifact failure.zip
+
+artifacts:
+  - path: '*.Rcheck\**\*.log'
+    name: Logs
+  - path: '*.Rcheck\**\*.out'
+    name: Logs
+  - path: '*.Rcheck\**\*.fail'
+    name: Logs
+  - path: '*.Rcheck\**\*.Rout'
+    name: Logs
+  - path: '\*_*.tar.gz'
+    name: Bits
+  - path: '\*_*.zip'
+    name: Bits
+
+deploy:
+  provider: GitHub
+  description: Windows Binary
+  auth_token:
+    secure: h+8/Q2kGkLoaoZ8OEtsplJGXuPFhS/VQbtE66cMJj7J3PeDgNAROVkV7368h3s+b
+  draft: no
+  prerelease: no
+  on:
+    APPVEYOR_REPO_TAG: true
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
new file mode 100644
index 0000000..75f2cf4
--- /dev/null
+++ b/docs/LICENSE-text.html
@@ -0,0 +1,826 @@
+
+
+
+  
+  
+
+
+
+License • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+
+  
+    

+      

+      
+
+      
+      

+
+

+  

+    

+      
License

+    

+
+
GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {one line to give the program's name and a brief idea of what it does.}
+    Copyright (C) {year}  {name of author}
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    {project}  Copyright (C) {year}  {fullname}
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+

+
+  

+
+

+
+
+      
+   

+
+  
+
+  
+
+
diff --git a/docs/apple-touch-icon-120x120.png b/docs/apple-touch-icon-120x120.png
new file mode 100644
index 0000000..6965c81
Binary files /dev/null and b/docs/apple-touch-icon-120x120.png differ
diff --git a/docs/apple-touch-icon-152x152.png b/docs/apple-touch-icon-152x152.png
new file mode 100644
index 0000000..d199cc4
Binary files /dev/null and b/docs/apple-touch-icon-152x152.png differ
diff --git a/docs/apple-touch-icon-180x180.png b/docs/apple-touch-icon-180x180.png
new file mode 100644
index 0000000..fb3724a
Binary files /dev/null and b/docs/apple-touch-icon-180x180.png differ
diff --git a/docs/apple-touch-icon-60x60.png b/docs/apple-touch-icon-60x60.png
new file mode 100644
index 0000000..b5ba3dd
Binary files /dev/null and b/docs/apple-touch-icon-60x60.png differ
diff --git a/docs/apple-touch-icon-76x76.png b/docs/apple-touch-icon-76x76.png
new file mode 100644
index 0000000..cf04519
Binary files /dev/null and b/docs/apple-touch-icon-76x76.png differ
diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png
new file mode 100644
index 0000000..a50d8dd
Binary files /dev/null and b/docs/apple-touch-icon.png differ
diff --git a/docs/articles/index.html b/docs/articles/index.html
new file mode 100644
index 0000000..83fcc56
--- /dev/null
+++ b/docs/articles/index.html
@@ -0,0 +1,158 @@
+
+
+
+  
+  
+
+
+
+Articles • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+
+  
+    

+      

+      
+
+      
+      

+
+

+  

+    

+      
Articles

+    

+
+    

+      
All vignettes

+      

+
+      
+    

+  

+

+
+      
+   

+
+  
+
+  
+
+
diff --git a/docs/articles/z1_install.html b/docs/articles/z1_install.html
new file mode 100644
index 0000000..13d18d3
--- /dev/null
+++ b/docs/articles/z1_install.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+
+1 - Installing teachR • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    

+      

+
+
+      
+      

+  

+    

+      
1 - Installing teachR

+            
+      
+      Source: vignettes/z1_install.Rmd
+      
+
+    

+
+    
+    
+
This page describes the installation process of teachR.

+
teachR has not been released on CRAN yet, but it can be easily installed from its GitHub repository with the following steps.

+

+
+

+

+

+1.1 - Before installing

+
Before installing teachR, you will need to install the latest version of the devtools package. You can install devtools from CRAN as follows:

+
if (!require(devtools))
+  install.packages("devtools")

+

+

+

+

+1.2 - Installing teachR

+
You can install teachR as follows:

+
devtools::install_github("swarm-lab/teachR")

+

+

+

+

+1.3 - Loading teachR

+
library(teachR)

+

+  

+
+  
+
+

+
+
+      
+

+
+  
+
+  
+
diff --git a/docs/articles/z2_usage.html b/docs/articles/z2_usage.html
new file mode 100644
index 0000000..15e18fb
--- /dev/null
+++ b/docs/articles/z2_usage.html
@@ -0,0 +1,125 @@
+
+
+
+
+
+
+
+1 - Installing teachR • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    

+      

+
+
+      
+      

+  

+    

+      
1 - Installing teachR

+            
+      
+      Source: vignettes/z2_usage.Rmd
+      
+
+    

+
+    
+    
+
This page describes how to use teachR.

+  

+
+  
+
+

+
+
+      
+

+
+  
+
+  
+
diff --git a/docs/articles/z3_participate.html b/docs/articles/z3_participate.html
new file mode 100644
index 0000000..e94d138
--- /dev/null
+++ b/docs/articles/z3_participate.html
@@ -0,0 +1,125 @@
+
+
+
+
+
+
+
+1 - Installing teachR • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    

+      

+
+
+      
+      

+  

+    

+      
1 - Installing teachR

+            
+      
+      Source: vignettes/z3_participate.Rmd
+      
+
+    

+
+    
+    
+
This page describes how to add apps to teachR.

+  

+
+  
+
+

+
+
+      
+

+
+  
+
+  
+
diff --git a/docs/authors.html b/docs/authors.html
new file mode 100644
index 0000000..354a47b
--- /dev/null
+++ b/docs/authors.html
@@ -0,0 +1,157 @@
+
+
+
+  
+  
+
+
+
+Authors • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+
+  
+    

+      

+      
+
+      
+      

+
+

+  

+    

+      
Authors

+    

+
+    
+
+  

+
+

+
+
+      
+   

+
+  
+
+  
+
+
diff --git a/docs/docsearch.css b/docs/docsearch.css
new file mode 100644
index 0000000..e5f1fe1
--- /dev/null
+++ b/docs/docsearch.css
@@ -0,0 +1,148 @@
+/* Docsearch -------------------------------------------------------------- */
+/*
+  Source: https://github.com/algolia/docsearch/
+  License: MIT
+*/
+
+.algolia-autocomplete {
+  display: block;
+  -webkit-box-flex: 1;
+  -ms-flex: 1;
+  flex: 1
+}
+
+.algolia-autocomplete .ds-dropdown-menu {
+  width: 100%;
+  min-width: none;
+  max-width: none;
+  padding: .75rem 0;
+  background-color: #fff;
+  background-clip: padding-box;
+  border: 1px solid rgba(0, 0, 0, .1);
+  box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175);
+}
+
+@media (min-width:768px) {
+  .algolia-autocomplete .ds-dropdown-menu {
+      width: 175%
+  }
+}
+
+.algolia-autocomplete .ds-dropdown-menu::before {
+  display: none
+}
+
+.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] {
+  padding: 0;
+  background-color: rgb(255,255,255);
+  border: 0;
+  max-height: 80vh;
+}
+
+.algolia-autocomplete .ds-dropdown-menu .ds-suggestions {
+  margin-top: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion {
+  padding: 0;
+  overflow: visible
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--category-header {
+  padding: .125rem 1rem;
+  margin-top: 0;
+  font-size: 1.3em;
+  font-weight: 500;
+  color: #00008B;
+  border-bottom: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {
+    float: none;
+    padding-top: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {
+  float: none;
+  width: auto;
+  padding: 0;
+  text-align: left
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--content {
+  float: none;
+  width: auto;
+  padding: 0
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--content::before {
+  display: none
+}
+
+.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header {
+  padding-top: .75rem;
+  margin-top: .75rem;
+  border-top: 1px solid rgba(0, 0, 0, .1)
+}
+
+.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column {
+  display: block;
+  padding: .1rem 1rem;
+  margin-bottom: 0.1;
+  font-size: 1.0em;
+  font-weight: 400
+  /* display: none */
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--title {
+  display: block;
+  padding: .25rem 1rem;
+  margin-bottom: 0;
+  font-size: 0.9em;
+  font-weight: 400
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--text {
+  padding: 0 1rem .5rem;
+  margin-top: -.25rem;
+  font-size: 0.8em;
+  font-weight: 400;
+  line-height: 1.25
+}
+
+.algolia-autocomplete .algolia-docsearch-footer {
+  width: 110px;
+  height: 20px;
+  z-index: 3;
+  margin-top: 10.66667px;
+  float: right;
+  font-size: 0;
+  line-height: 0;
+}
+
+.algolia-autocomplete .algolia-docsearch-footer--logo {
+  background-image: url("data:image/svg+xml;utf8,");
+  background-repeat: no-repeat;
+  background-position: 50%;
+  background-size: 100%;
+  overflow: hidden;
+  text-indent: -9000px;
+  width: 100%;
+  height: 100%;
+  display: block;
+  transform: translate(-8px);
+}
+
+.algolia-autocomplete .algolia-docsearch-suggestion--highlight {
+  color: #FF8C00;
+  background: rgba(232, 189, 54, 0.1)
+}
+
+
+.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
+  box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5)
+}
+
+.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content {
+  background-color: rgba(192, 192, 192, .15)
+}
diff --git a/docs/docsearch.js b/docs/docsearch.js
new file mode 100644
index 0000000..b35504c
--- /dev/null
+++ b/docs/docsearch.js
@@ -0,0 +1,85 @@
+$(function() {
+
+  // register a handler to move the focus to the search bar
+  // upon pressing shift + "/" (i.e. "?")
+  $(document).on('keydown', function(e) {
+    if (e.shiftKey && e.keyCode == 191) {
+      e.preventDefault();
+      $("#search-input").focus();
+    }
+  });
+
+  $(document).ready(function() {
+    // do keyword highlighting
+    /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */
+    var mark = function() {
+
+      var referrer = document.URL ;
+      var paramKey = "q" ;
+
+      if (referrer.indexOf("?") !== -1) {
+        var qs = referrer.substr(referrer.indexOf('?') + 1);
+        var qs_noanchor = qs.split('#')[0];
+        var qsa = qs_noanchor.split('&');
+        var keyword = "";
+
+        for (var i = 0; i < qsa.length; i++) {
+          var currentParam = qsa[i].split('=');
+
+          if (currentParam.length !== 2) {
+            continue;
+          }
+
+          if (currentParam[0] == paramKey) {
+            keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20"));
+          }
+        }
+
+        if (keyword !== "") {
+          $(".contents").unmark({
+            done: function() {
+              $(".contents").mark(keyword);
+            }
+          });
+        }
+      }
+    };
+
+    mark();
+  });
+});
+
+/* Search term highlighting ------------------------------*/
+
+function matchedWords(hit) {
+  var words = [];
+
+  var hierarchy = hit._highlightResult.hierarchy;
+  // loop to fetch from lvl0, lvl1, etc.
+  for (var idx in hierarchy) {
+    words = words.concat(hierarchy[idx].matchedWords);
+  }
+
+  var content = hit._highlightResult.content;
+  if (content) {
+    words = words.concat(content.matchedWords);
+  }
+
+  // return unique words
+  var words_uniq = [...new Set(words)];
+  return words_uniq;
+}
+
+function updateHitURL(hit) {
+
+  var words = matchedWords(hit);
+  var url = "";
+
+  if (hit.anchor) {
+    url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor;
+  } else {
+    url = hit.url + '?q=' + escape(words.join(" "));
+  }
+
+  return url;
+}
diff --git a/docs/favicon-16x16.png b/docs/favicon-16x16.png
new file mode 100644
index 0000000..2f05615
Binary files /dev/null and b/docs/favicon-16x16.png differ
diff --git a/docs/favicon-32x32.png b/docs/favicon-32x32.png
new file mode 100644
index 0000000..24639e9
Binary files /dev/null and b/docs/favicon-32x32.png differ
diff --git a/docs/favicon.ico b/docs/favicon.ico
new file mode 100644
index 0000000..acbcbf1
Binary files /dev/null and b/docs/favicon.ico differ
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..10a1d8c
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,178 @@
+
+
+
+
+
+
+
+R Package For Distributing Web Applications For Educational Use  • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    

+      

+
+
+      
+      

+  

+    
+
+    
+    
+

+

+teachR - R package for distributing web applications for educational use

+
+
Please submit all suggestions and bug reports here. Thanks!

+

+

+

+Description 
+

+
teachR is a package for R that bundles several Shiny web applications for educational use.

+
The goal of teachR is to provide teachers and educators with free, easy-to-use and interactive applications for complementing their courses with virtual demonstrations and/or experiments.

+
The Shiny applications in teachR can be launched directly from within R or RStudio. They can also be exported toward a local folder for later deployment on shinyapp.io or on a personal Shiny Server instance.

+
The teachR package is at a very early stage of development. It contains only a few Shiny applications at the moment, but this number is meant to grow with the help of Shiny developers looking to make their educational web applications more easily accessible.

+
If you are a Shiny developer and want to participate, just fork this repository, add your application(s) to the “inst/apps” folder with a properly formatted “info” file (see other apps for examples), and send me a pull request.

+

+

+

+

+Quick start guides

+
    
+
  1. Installing teachR
    2. 
+
  2. Using teachR
    3. 
+
  3. Adding new apps to teachR
    4. 
+

+

+

+

+  

+
+  
+
+

+
+
+      
+

+
+  
+
+  
+
diff --git a/docs/link.svg b/docs/link.svg
new file mode 100644
index 0000000..88ad827
--- /dev/null
+++ b/docs/link.svg
@@ -0,0 +1,12 @@
+
+
+
+
+
+
diff --git a/docs/logo.svg b/docs/logo.svg
new file mode 100644
index 0000000..65fab7e
--- /dev/null
+++ b/docs/logo.svg
@@ -0,0 +1,23 @@
+
+
+
+
+
+	
+	teachR
+
+
+	
+
+
diff --git a/docs/pkgdown.css b/docs/pkgdown.css
new file mode 100644
index 0000000..c03fb08
--- /dev/null
+++ b/docs/pkgdown.css
@@ -0,0 +1,236 @@
+/* Sticky footer */
+
+/**
+ * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
+ * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
+ *
+ * .Site -> body > .container
+ * .Site-content -> body > .container .row
+ * .footer -> footer
+ *
+ * Key idea seems to be to ensure that .container and __all its parents__
+ * have height set to 100%
+ *
+ */
+
+html, body {
+  height: 100%;
+}
+
+body > .container {
+  display: flex;
+  height: 100%;
+  flex-direction: column;
+
+  padding-top: 60px;
+}
+
+body > .container .row {
+  flex: 1 0 auto;
+}
+
+footer {
+  margin-top: 45px;
+  padding: 35px 0 36px;
+  border-top: 1px solid #e5e5e5;
+  color: #666;
+  display: flex;
+  flex-shrink: 0;
+}
+footer p {
+  margin-bottom: 0;
+}
+footer div {
+  flex: 1;
+}
+footer .pkgdown {
+  text-align: right;
+}
+footer p {
+  margin-bottom: 0;
+}
+
+img.icon {
+  float: right;
+}
+
+img {
+  max-width: 100%;
+}
+
+/* Fix bug in bootstrap (only seen in firefox) */
+summary {
+  display: list-item;
+}
+
+/* Typographic tweaking ---------------------------------*/
+
+.contents .page-header {
+  margin-top: calc(-60px + 1em);
+}
+
+/* Section anchors ---------------------------------*/
+
+a.anchor {
+  margin-left: -30px;
+  display:inline-block;
+  width: 30px;
+  height: 30px;
+  visibility: hidden;
+
+  background-image: url(./link.svg);
+  background-repeat: no-repeat;
+  background-size: 20px 20px;
+  background-position: center center;
+}
+
+.hasAnchor:hover a.anchor {
+  visibility: visible;
+}
+
+@media (max-width: 767px) {
+  .hasAnchor:hover a.anchor {
+    visibility: hidden;
+  }
+}
+
+
+/* Fixes for fixed navbar --------------------------*/
+
+.contents h1, .contents h2, .contents h3, .contents h4 {
+  padding-top: 60px;
+  margin-top: -40px;
+}
+
+/* Static header placement on mobile devices */
+@media (max-width: 767px) {
+  .navbar-fixed-top {
+    position: absolute;
+  }
+  .navbar {
+    padding: 0;
+  }
+}
+
+
+/* Sidebar --------------------------*/
+
+#sidebar {
+  margin-top: 30px;
+}
+#sidebar h2 {
+  font-size: 1.5em;
+  margin-top: 1em;
+}
+
+#sidebar h2:first-child {
+  margin-top: 0;
+}
+
+#sidebar .list-unstyled li {
+  margin-bottom: 0.5em;
+}
+
+.orcid {
+  height: 16px;
+  vertical-align: middle;
+}
+
+/* Reference index & topics ----------------------------------------------- */
+
+.ref-index th {font-weight: normal;}
+
+.ref-index td {vertical-align: top;}
+.ref-index .icon {width: 40px;}
+.ref-index .alias {width: 40%;}
+.ref-index-icons .alias {width: calc(40% - 40px);}
+.ref-index .title {width: 60%;}
+
+.ref-arguments th {text-align: right; padding-right: 10px;}
+.ref-arguments th, .ref-arguments td {vertical-align: top;}
+.ref-arguments .name {width: 20%;}
+.ref-arguments .desc {width: 80%;}
+
+/* Nice scrolling for wide elements --------------------------------------- */
+
+table {
+  display: block;
+  overflow: auto;
+}
+
+/* Syntax highlighting ---------------------------------------------------- */
+
+pre {
+  word-wrap: normal;
+  word-break: normal;
+  border: 1px solid #eee;
+}
+
+pre, code {
+  background-color: #f8f8f8;
+  color: #333;
+}
+
+pre code {
+  overflow: auto;
+  word-wrap: normal;
+  white-space: pre;
+}
+
+pre .img {
+  margin: 5px 0;
+}
+
+pre .img img {
+  background-color: #fff;
+  display: block;
+  height: auto;
+}
+
+code a, pre a {
+  color: #375f84;
+}
+
+a.sourceLine:hover {
+  text-decoration: none;
+}
+
+.fl      {color: #1514b5;}
+.fu      {color: #000000;} /* function */
+.ch,.st  {color: #036a07;} /* string */
+.kw      {color: #264D66;} /* keyword */
+.co      {color: #888888;} /* comment */
+
+.message { color: black;   font-weight: bolder;}
+.error   { color: orange;  font-weight: bolder;}
+.warning { color: #6A0366; font-weight: bolder;}
+
+/* Clipboard --------------------------*/
+
+.hasCopyButton {
+  position: relative;
+}
+
+.btn-copy-ex {
+  position: absolute;
+  right: 0;
+  top: 0;
+  visibility: hidden;
+}
+
+.hasCopyButton:hover button.btn-copy-ex {
+  visibility: visible;
+}
+
+/* mark.js ----------------------------*/
+
+mark {
+  background-color: rgba(255, 255, 51, 0.5);
+  border-bottom: 2px solid rgba(255, 153, 51, 0.3);
+  padding: 1px;
+}
+
+/* vertical spacing after htmlwidgets */
+.html-widget {
+  margin-bottom: 10px;
+}
diff --git a/docs/pkgdown.js b/docs/pkgdown.js
new file mode 100644
index 0000000..eb7e83d
--- /dev/null
+++ b/docs/pkgdown.js
@@ -0,0 +1,115 @@
+/* http://gregfranko.com/blog/jquery-best-practices/ */
+(function($) {
+  $(function() {
+
+    $("#sidebar")
+      .stick_in_parent({offset_top: 40})
+      .on('sticky_kit:bottom', function(e) {
+        $(this).parent().css('position', 'static');
+      })
+      .on('sticky_kit:unbottom', function(e) {
+        $(this).parent().css('position', 'relative');
+      });
+
+    $('body').scrollspy({
+      target: '#sidebar',
+      offset: 60
+    });
+
+    $('[data-toggle="tooltip"]').tooltip();
+
+    var cur_path = paths(location.pathname);
+    var links = $("#navbar ul li a");
+    var max_length = -1;
+    var pos = -1;
+    for (var i = 0; i < links.length; i++) {
+      if (links[i].getAttribute("href") === "#")
+        continue;
+      // Ignore external links
+      if (links[i].host !== location.host)
+        continue;
+
+      var nav_path = paths(links[i].pathname);
+
+      var length = prefix_length(nav_path, cur_path);
+      if (length > max_length) {
+        max_length = length;
+        pos = i;
+      }
+    }
+
+    // Add class to parent 
  • , and enclosing 
  •  if in dropdown
+    if (pos >= 0) {
+      var menu_anchor = $(links[pos]);
+      menu_anchor.parent().addClass("active");
+      menu_anchor.closest("li.dropdown").addClass("active");
+    }
+  });
+
+  function paths(pathname) {
+    var pieces = pathname.split("/");
+    pieces.shift(); // always starts with /
+
+    var end = pieces[pieces.length - 1];
+    if (end === "index.html" || end === "")
+      pieces.pop();
+    return(pieces);
+  }
+
+  // Returns -1 if not found
+  function prefix_length(needle, haystack) {
+    if (needle.length > haystack.length)
+      return(-1);
+
+    // Special case for length-0 haystack, since for loop won't run
+    if (haystack.length === 0) {
+      return(needle.length === 0 ? 0 : -1);
+    }
+
+    for (var i = 0; i < haystack.length; i++) {
+      if (needle[i] != haystack[i])
+        return(i);
+    }
+
+    return(haystack.length);
+  }
+
+  /* Clipboard --------------------------*/
+
+  function changeTooltipMessage(element, msg) {
+    var tooltipOriginalTitle=element.getAttribute('data-original-title');
+    element.setAttribute('data-original-title', msg);
+    $(element).tooltip('show');
+    element.setAttribute('data-original-title', tooltipOriginalTitle);
+  }
+
+  if(ClipboardJS.isSupported()) {
+    $(document).ready(function() {
+      var copyButton = "";
+
+      $(".examples, div.sourceCode").addClass("hasCopyButton");
+
+      // Insert copy buttons:
+      $(copyButton).prependTo(".hasCopyButton");
+
+      // Initialize tooltips:
+      $('.btn-copy-ex').tooltip({container: 'body'});
+
+      // Initialize clipboard:
+      var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', {
+        text: function(trigger) {
+          return trigger.parentNode.textContent;
+        }
+      });
+
+      clipboardBtnCopies.on('success', function(e) {
+        changeTooltipMessage(e.trigger, 'Copied!');
+        e.clearSelection();
+      });
+
+      clipboardBtnCopies.on('error', function() {
+        changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy');
+      });
+    });
+  }
+})(window.jQuery || window.$)
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
new file mode 100644
index 0000000..3fe4226
--- /dev/null
+++ b/docs/pkgdown.yml
@@ -0,0 +1,11 @@
+pandoc: 1.19.2.1
+pkgdown: 1.3.0
+pkgdown_sha: ~
+articles:
+  z1_install: z1_install.html
+  z2_usage: z2_usage.html
+  z3_participate: z3_participate.html
+urls:
+  reference: https://swarm-lab.github.io/teachR//reference
+  article: https://swarm-lab.github.io/teachR//articles
+
diff --git a/docs/reference/export_app.html b/docs/reference/export_app.html
new file mode 100644
index 0000000..4e6917d
--- /dev/null
+++ b/docs/reference/export_app.html
@@ -0,0 +1,204 @@
+
+
+
+  
+  
+
+
+
+Export <code>teachR</code> Apps — export_app • teachR
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  
+
+  
+    
    
+      
    
+      
+
+      
+      
    
+
+
    
+  
    
+    
    
+    
    Export teachR Apps
    
+    Source: R/export_app.R
+    
+    
    
+
+    
    
+    
+    
    This function exports a Shiny app provided by the 
+ teachR library to a local folder on 
+ a user's computer. Useful for modifying the app or running it on a Shiny 
+ Server instance for example.
    
+    
+    
    
+
+    
    export_app(app, dest)
    
+    
+    
    Arguments
    
+
    • + + + + + + + + + +
    app

    The name of the app to export.

    dest

    The destination of the app folder on the user's computer. A folder +with the name of the app will be created at this location.

    + +

    Value

    + +

    This function does not return anything.

    + + +

    Examples

    + 
    # NOT RUN {
+ # Export app to the current working directory
+ export_app("aggregation_segregation", ".")
+# }
    
+
    + + + + + + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..6c7a1f8 --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,203 @@ + + + + + + + + +Function reference • teachR + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    Reference

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    export_app()

    +

    Export teachR Apps

    +

    list_apps()

    +

    List teachR Apps

    +

    list_categories()

    +

    List Categories of All teachR Apps

    +

    list_keywords()

    +

    List Keywords of All teachR Apps

    +

    run_app()

    +

    Run teachR Apps

    +
    + + +
    + + +
    + + + + + + diff --git a/docs/reference/list_apps.html b/docs/reference/list_apps.html new file mode 100644 index 0000000..2c6bdbf --- /dev/null +++ b/docs/reference/list_apps.html @@ -0,0 +1,212 @@ + + + + + + + + +List <code>teachR</code> Apps — list_apps • teachR + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    List teachR Apps

    + Source: R/list_apps.R + +
    + +
    + +

    This function generates a webpage listing all the apps available + through the teachR library. The list can be filtered by category + (type list_categories() for a list of existing categories) and + keywords (type list_keywords() for a list of existing keywords).

    + +
    + + 
    list_apps(categories = NULL, keywords = NULL)
    + +

    Arguments

    + + + + + + + + + + +
    categories

    A character string or a vector of character strings +corresponding to existing app categories (case insensitive).

    keywords

    A character string or a vector of character strings +corresponding to existing app keywords (case insensitive).

    + +

    Value

    + +

    This function opens an html file.

    + +

    Details

    + +

    If called from RStudio, the list will open in the internal RStudio + viewer. If called from a terminal, it will open in your default internet + browser.

    + + +

    Examples

    + 
    # NOT RUN {
+ list_apps(categories = c("biology", "social science"))
+# }
    
+
    +
    + +
    + + +
    + + + + + + diff --git a/docs/reference/list_categories.html b/docs/reference/list_categories.html new file mode 100644 index 0000000..e557f4a --- /dev/null +++ b/docs/reference/list_categories.html @@ -0,0 +1,185 @@ + + + + + + + + +List Categories of All <code>teachR</code> Apps — list_categories • teachR + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    List Categories of All teachR Apps

    + Source: R/list_categories.R + +
    + +
    + +

    This function generates a listing of all the categories of apps + available through the teachR library.

    + +
    + + 
    list_categories()
    + +

    Value

    + +

    A vector of character strings, each of them corresponding to a different + category.

    + + +

    Examples

    + 
    # NOT RUN {
+ list_categories()
+# }
    
+
    +
    + +
    + + +
    + + + + + + diff --git a/docs/reference/list_keywords.html b/docs/reference/list_keywords.html new file mode 100644 index 0000000..1a7a8d0 --- /dev/null +++ b/docs/reference/list_keywords.html @@ -0,0 +1,185 @@ + + + + + + + + +List Keywords of All <code>teachR</code> Apps — list_keywords • teachR + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    List Keywords of All teachR Apps

    + Source: R/list_keywords.R + +
    + +
    + +

    This function generates a listing of all the keywords of apps + available through the teachR library.

    + +
    + + 
    list_keywords()
    + +

    Value

    + +

    A vector of character strings, each of them corresponding to a different + keyword.

    + + +

    Examples

    + 
    # NOT RUN {
+ list_keywords()
+# }
    
+
    +
    + +
    + + +
    + + + + + + diff --git a/docs/reference/run_app.html b/docs/reference/run_app.html new file mode 100644 index 0000000..246327a --- /dev/null +++ b/docs/reference/run_app.html @@ -0,0 +1,206 @@ + + + + + + + + +Run <code>teachR</code> Apps — run_app • teachR + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    +

    Run teachR Apps

    + Source: R/run_app.R + +
    + +
    + +

    This function calls a Shiny app provided by the + teachR library. The list of available Shiny apps can be obtained by + typing list_apps() in your R terminal.

    + +
    + + 
    run_app(app)
    + +

    Arguments

    + + + + + + +
    app

    The name of the app to run.

    + +

    Value

    + +

    This function does not return anything.

    + +

    Details

    + +

    If called from RStudio, the app will open in the internal RStudio + internet browser. If called from a terminal, it will open in your default + internet browser. All apps should work without any problem with the internal + RStudio internet browser, as well as with recent versions of most internet + browsers. It is likely to break with older versions.

    + + +

    Examples

    + 
    # NOT RUN {
+ run_app("aggregation_segregation")
+# }
    
+
    +
    + +
    + + +
    + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..4ab8557 --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,30 @@ + + + + https://swarm-lab.github.io/teachR//index.html + + + https://swarm-lab.github.io/teachR//reference/export_app.html + + + https://swarm-lab.github.io/teachR//reference/list_apps.html + + + https://swarm-lab.github.io/teachR//reference/list_categories.html + + + https://swarm-lab.github.io/teachR//reference/list_keywords.html + + + https://swarm-lab.github.io/teachR//reference/run_app.html + + + https://swarm-lab.github.io/teachR//articles/z1_install.html + + + https://swarm-lab.github.io/teachR//articles/z2_usage.html + + + https://swarm-lab.github.io/teachR//articles/z3_participate.html + + diff --git a/index.Rmd b/index.Rmd new file mode 100644 index 0000000..585a1ea --- /dev/null +++ b/index.Rmd @@ -0,0 +1,49 @@ +--- +output: github_document +--- + +# teachR - R package for distributing web applications for educational use + +[![Travis-CI Build Status](https://travis-ci.org/swarm-lab/teachR.svg?branch=master)](https://travis-ci.org/swarm-lab/teachR) +[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/swarm-lab/teachR?branch=master&svg=true)](https://ci.appveyor.com/project/swarm-lab/teachR) + +**Please submit all suggestions and bug reports +[here](https://github.com/swarm-lab/teachR/issues). Thanks!** + +--- + +## Description + +`teachR` is a package for [`R`](http://www.r-project.org) that bundles several +[`Shiny`](http://shiny.rstudio.com/) web applications for educational use. + +The goal of `teachR` is to provide teachers and educators with free, easy-to-use +and interactive applications for complementing their courses with virtual +demonstrations and/or experiments. + +The [`Shiny`](http://shiny.rstudio.com/) applications in `teachR` can be launched +directly from within [`R`](http://www.r-project.org) or [`RStudio`](http://www.rstudio.com). +They can also be exported toward a local folder for later deployment +on [`shinyapp.io`](https://www.shinyapps.io/) or on a personal +[`Shiny Server`](http://www.rstudio.com/products/shiny/shiny-server/) instance. + +The `teachR` package is at a very early stage of development. It contains only a +few [`Shiny`](http://shiny.rstudio.com/) applications at the moment, but this +number is meant to grow with the help of [`Shiny`](http://shiny.rstudio.com/) +developers looking to make their educational web applications more easily +accessible. + +If you are a [`Shiny`](http://shiny.rstudio.com/) developer and want to +participate, just fork this repository, add your application(s) to the "inst/apps" +folder with a properly formatted "info" file (see other apps for examples), and +send me a pull request. + +--- + +## Quick start guides + +1. [Installing teachR](https://swarm-lab.github.io/teachR/articles/z1_install) +2. [Using teachR](https://swarm-lab.github.io/ROpenCVLite/articles/z2_usage.html) +3. [Adding new apps to teachR](https://swarm-lab.github.io/ROpenCVLite/articles/z3_participate.html) + +--- diff --git a/inst/apps/aggregation_segregation/global.R b/inst/apps/aggregation_segregation/global.R old mode 100755 new mode 100644 diff --git a/inst/apps/aggregation_segregation/server.R b/inst/apps/aggregation_segregation/server.R old mode 100755 new mode 100644 diff --git a/inst/apps/aggregation_segregation/ui.R b/inst/apps/aggregation_segregation/ui.R old mode 100755 new mode 100644 diff --git a/inst/apps/aggregation_segregation/www/actions.js b/inst/apps/aggregation_segregation/www/actions.js old mode 100755 new mode 100644 diff --git a/inst/apps/aggregation_segregation/www/white-rstudio-logo.png b/inst/apps/aggregation_segregation/www/white-rstudio-logo.png old mode 100755 new mode 100644 diff --git a/inst/html/template.html b/inst/html_templates/template.html similarity index 95% rename from inst/html/template.html rename to inst/html_templates/template.html index 245655d..007bd72 100644 --- a/inst/html/template.html +++ b/inst/html_templates/template.html @@ -3,7 +3,7 @@ -#!title# +Apps available in teachR + + + + + + + + + + + + +

    1 - Installing teachR

    + + + +

    This page describes the installation process of teachR.

    +

    teachR has not been released on CRAN yet, but it can be easily installed from its GitHub repository with the following steps.

    +
    + +
    +
    +

    1.1 - Before installing

    +

    Before installing teachR, you will need to install the latest version of the devtools package. You can install devtools from CRAN as follows:

    +
    if (!require(devtools))
+  install.packages("devtools")
    +
    +
    +
    +

    1.2 - Installing teachR

    +

    You can install teachR as follows:

    +
    devtools::install_github("swarm-lab/teachR")
    +
    +
    +
    +

    1.3 - Loading teachR

    +
    library(teachR)
    +
    + + + + + + + + diff --git a/vignettes/z2_usage.Rmd b/vignettes/z2_usage.Rmd new file mode 100644 index 0000000..730ed18 --- /dev/null +++ b/vignettes/z2_usage.Rmd @@ -0,0 +1,10 @@ +--- +title: "1 - Installing teachR" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{pkgdown} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + +__This page describes how to use [`teachR`](https://github.com/swarm-lab/teachR).__ diff --git a/vignettes/z2_usage.html b/vignettes/z2_usage.html new file mode 100644 index 0000000..b8bf453 --- /dev/null +++ b/vignettes/z2_usage.html @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + +1 - Installing teachR + + + + + + + + + + + + + + + +

    1 - Installing teachR

    + + + +

    This page describes how to use teachR.

    + + + + + + + + diff --git a/vignettes/z3_participate.Rmd b/vignettes/z3_participate.Rmd new file mode 100644 index 0000000..67d0917 --- /dev/null +++ b/vignettes/z3_participate.Rmd @@ -0,0 +1,10 @@ +--- +title: "1 - Installing teachR" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{pkgdown} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + +__This page describes how to add apps to [`teachR`](https://github.com/swarm-lab/teachR).__ diff --git a/vignettes/z3_participate.html b/vignettes/z3_participate.html new file mode 100644 index 0000000..d70b8a4 --- /dev/null +++ b/vignettes/z3_participate.html @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + +1 - Installing teachR + + + + + + + + + + + + + + + +

    1 - Installing teachR

    + + + +

    This page describes how to add apps to teachR.

    + + + + + + + +