assignation2(), challenge() and challenge2() added for group assignments and for individual or group challenges

Author: phgrosjean

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: learndown
 Type: Package
-Version: 1.1.8
+Version: 1.2.0
 Title: 'SciViews' - R Markdown and Bookdown Additions for Learning Material
 Description: Extension to R Markdown and Bookdown for building better learning
   and e-learning material: H5P integration, course-contextual divs, different

NAMESPACE

@@ -1,8 +1,17 @@
 # Generated by roxygen2: do not edit by hand
 
 export(assignation)
+export(assignation2)
+export(assignation2_en)
+export(assignation2_fr)
 export(assignation_en)
 export(assignation_fr)
+export(challenge)
+export(challenge2)
+export(challenge2_en)
+export(challenge2_fr)
+export(challenge_en)
+export(challenge_fr)
 export(check_shiny_solution)
 export(checker_ack_learnr)
 export(config)

NEWS.md

@@ -1,3 +1,9 @@
+# learndown 1.2.0
+
+- There are now more GitHub assignation types : `assign2()` for group assignations and `challenge()`/`challenge2()` for assignations linked to challenges (individual or in groups).
+
+- Images related to exercise blocks and suggested `style0.css` and `preamble.tex`to be used for {learndown}-enabled {bookdown}s are also provided now.
+
 # learndown 1.1.8
 
 - Argument `upgrade=` added to `run()`, `run_app()` and `update_pkg()`. By default, it is "never", which is a good value inside the SciViews Box, but "ask" may be more appropriate elsewhere.

R/assignation.R

@@ -1,11 +1,11 @@
-#' Insert a GitHub assignation in the document
+#' Insert a GitHub assignation or challenge in the document
 #'
-#' Insert a block of class `assign` with data related to a GitHub (Classroom)
+#' Insert a block of class `assign`, `assign2`, `challenge` or `challenge2` with data related to a GitHub (Classroom)
 #' assignment.
 #'
-#' @param name The name of the assignation (usually the same as the name of the
+#' @param name The name of the assignation or the challenge (usually the same as the name of the
 #' template GitHub repository).
-#' @param url The URL of the assignation (could be a named list for different
+#' @param url The URL of the assignation or challenge (could be a named list for different
 #' versions depending on the course).
 #' @param course.urls Named vector with the Classroom URLS for each course.
 #' Names are the course identifiers in Moodle. If `NULL`, no course-specific
@@ -25,6 +25,7 @@
 #' the ex-toc.
 #' @param assign.link The link to the learnr help page (when the user clicks on
 #' the image in the ex-toc).
+#' @param block The class of the div, or the LaTeX environment to use for the assignment block.
 #' @param title The title of the block.
 #' @param part.name The word to use for "part".
 #' @param alt The text to display for alternate access to the repository (for
@@ -45,7 +46,7 @@
 assignation <- function(name, url, course.urls = NULL, part = NULL,
 course.names = c(course1 = "Data Science"), toc = "",
 texts = assignation_en(), assign.img = "images/list-assign.png",
-assign.link = "github_assignation") {
+assign.link = "github_assignation", block = "assign") {
   if (is.null(part)) {
     anchor <- name
     part <- ""
@@ -85,17 +86,47 @@ assign.link = "github_assignation") {
 
   alt_text <- glue::glue(texts$alt)
 
-  glue::glue("\n\\BeginKnitrBlock{{assign}}<div class=\"assign\">
+  glue::glue("\n\\BeginKnitrBlock{{{block}}}<div class=\"{block}\">
 {texts$title} **[{name}]{{#{anchor} }}{part}**.
 
 {course_text}
 
 {alt_text}
 
 *{texts$sub}{part}.*
-</div>\\EndKnitrBlock{{assign}}\n\n")
+</div>\\EndKnitrBlock{{{block}}}\n\n")
 }
 
+#' @rdname assignation
+#' @export
+assignation2 <- function(name, url, course.urls = NULL, part = NULL,
+course.names = c(course1 = "Data Science"), toc = "",
+texts = assignation2_en(), assign.img = "images/list-assign2.png",
+assign.link = "github_assignation", block = "assign2")
+  assignation(name, url, course.urls = course.urls, part = part,
+    course.names = course.names, toc = toc, texts = texts,
+    assign.img = assign.img, assign.link = assign.link, block = block)
+
+#' @rdname assignation
+#' @export
+challenge <- function(name, url, course.urls = NULL, part = NULL,
+  course.names = c(course1 = "Data Science"), toc = "",
+  texts = challenge_en(), assign.img = "images/list-challenge.png",
+  assign.link = "github_assignation", block = "challenge")
+  assignation(name, url, course.urls = course.urls, part = part,
+    course.names = course.names, toc = toc, texts = texts,
+    assign.img = assign.img, assign.link = assign.link, block = block)
+
+#' @rdname assignation
+#' @export
+challenge2 <- function(name, url, course.urls = NULL, part = NULL,
+  course.names = c(course1 = "Data Science"), toc = "",
+  texts = challenge2_en(), assign.img = "images/list-challenge2.png",
+  assign.link = "github_assignation", block = "challenge2")
+  assignation(name, url, course.urls = course.urls, part = part,
+    course.names = course.names, toc = toc, texts = texts,
+    assign.img = assign.img, assign.link = assign.link, block = block)
+
 #' @rdname assignation
 #' @export
 assignation_en <- function(title, part.name, alt, sub, course, toc.def) {
@@ -137,3 +168,129 @@ assignation_fr <- function(title, part.name, alt, sub, course, toc.def) {
 
   texts
 }
+
+#' @rdname assignation
+#' @export
+assignation2_en <- function(title, part.name, alt, sub, course, toc.def) {
+  texts <- list(
+    title     = "Complete this group assignation:",
+    part.name = "part",
+    alt       = "If you are not a registered user, or if you work outside of a course, fork [this]({url}){{target=\"_blank\"}} repository.",
+    sub      = "See the explanations in the `README.md`",
+    course   = "Group assignation for the students enrolled at the course",
+    toc.def  = "Group assignation {name}"
+  )
+  if (!missing(title)) texts$title <- title
+  if (!missing(part.name)) texts$part.name <- part.name
+  if (!missing(alt)) texts$alt <- alt
+  if (!missing(sub)) texts$sub <- sub
+  if (!missing(course)) texts$course <- course
+  if (!missing(toc.def)) texts$toc.def <- toc.def
+
+  texts
+}
+
+#' @rdname assignation
+#' @export
+assignation2_fr <- function(title, part.name, alt, sub, course, toc.def) {
+  texts <- list(
+    title     = "R\u00e9alisez en groupe l'assignation",
+    part.name = "partie",
+    alt       = "Si vous \u00eates un utilisateur non enregistr\u00e9 ou que vous travaillez en dehors d'un cours, faites un \"fork\" de [ce]({url}){{target=\"_blank\"}} d\u00e9p\u00f4t.",
+    sub       = "Voyez les explications dans le fichier `README.md`",
+    course    = "Assignation en groupe pour les \u00e9tudiants inscrits au cours de",
+    toc.def   = "Assignation en groupe {name}"
+  )
+  if (!missing(title)) texts$title <- title
+  if (!missing(part.name)) texts$part.name <- part.name
+  if (!missing(alt)) texts$alt <- alt
+  if (!missing(sub)) texts$sub <- sub
+  if (!missing(course)) texts$course <- course
+  if (!missing(toc.def)) texts$toc.def <- toc.def
+
+  texts
+}
+
+#' @rdname assignation
+#' @export
+challenge_en <- function(title, part.name, alt, sub, course, toc.def) {
+  texts <- list(
+    title     = "Accept this challenge:",
+    part.name = "part",
+    alt       = "If you are not a registered user, or if you work outside of a course, fork [this]({url}){{target=\"_blank\"}} repository.",
+    sub      = "See the explanations in the `README.md`",
+    course   = "Challenge for the students enrolled at the course",
+    toc.def  = "Challenge {name}"
+  )
+  if (!missing(title)) texts$title <- title
+  if (!missing(part.name)) texts$part.name <- part.name
+  if (!missing(alt)) texts$alt <- alt
+  if (!missing(sub)) texts$sub <- sub
+  if (!missing(course)) texts$course <- course
+  if (!missing(toc.def)) texts$toc.def <- toc.def
+
+  texts
+}
+
+#' @rdname assignation
+#' @export
+challenge_fr <- function(title, part.name, alt, sub, course, toc.def) {
+  texts <- list(
+    title     = "Relevez le challenge",
+    part.name = "partie",
+    alt       = "Si vous \u00eates un utilisateur non enregistr\u00e9 ou que vous travaillez en dehors d'un cours, faites un \"fork\" de [ce]({url}){{target=\"_blank\"}} d\u00e9p\u00f4t.",
+    sub       = "Voyez les explications dans le fichier `README.md`",
+    course    = "Challenge pour les \u00e9tudiants inscrits au cours de",
+    toc.def   = "Challenge {name}"
+  )
+  if (!missing(title)) texts$title <- title
+  if (!missing(part.name)) texts$part.name <- part.name
+  if (!missing(alt)) texts$alt <- alt
+  if (!missing(sub)) texts$sub <- sub
+  if (!missing(course)) texts$course <- course
+  if (!missing(toc.def)) texts$toc.def <- toc.def
+
+  texts
+}
+
+#' @rdname assignation
+#' @export
+challenge2_en <- function(title, part.name, alt, sub, course, toc.def) {
+  texts <- list(
+    title     = "Accept this group challenge:",
+    part.name = "part",
+    alt       = "If you are not a registered user, or if you work outside of a course, fork [this]({url}){{target=\"_blank\"}} repository.",
+    sub      = "See the explanations in the `README.md`",
+    course   = "Group challenge for the students enrolled at the course",
+    toc.def  = "Group challenge {name}"
+  )
+  if (!missing(title)) texts$title <- title
+  if (!missing(part.name)) texts$part.name <- part.name
+  if (!missing(alt)) texts$alt <- alt
+  if (!missing(sub)) texts$sub <- sub
+  if (!missing(course)) texts$course <- course
+  if (!missing(toc.def)) texts$toc.def <- toc.def
+
+  texts
+}
+
+#' @rdname assignation
+#' @export
+challenge2_fr <- function(title, part.name, alt, sub, course, toc.def) {
+  texts <- list(
+    title     = "Relevez ce challenge par groupe:",
+    part.name = "partie",
+    alt       = "Si vous \u00eates un utilisateur non enregistr\u00e9 ou que vous travaillez en dehors d'un cours, faites un \"fork\" de [ce]({url}){{target=\"_blank\"}} d\u00e9p\u00f4t.",
+    sub       = "Voyez les explications dans le fichier `README.md`",
+    course    = "Challenge en groupe pour les \u00e9tudiants inscrits au cours de",
+    toc.def   = "Challenge en groupe {name}"
+  )
+  if (!missing(title)) texts$title <- title
+  if (!missing(part.name)) texts$part.name <- part.name
+  if (!missing(alt)) texts$alt <- alt
+  if (!missing(sub)) texts$sub <- sub
+  if (!missing(course)) texts$course <- course
+  if (!missing(toc.def)) texts$toc.def <- toc.def
+
+  texts
+}

R/launch_shiny.R

@@ -57,7 +57,8 @@ launch_shiny <- function(url, app = basename(url),
 imgdir = "images/shinyapps", img = paste0(imgdir, "/", app, ".png"),
 createimg = TRUE, width = 780, height = 500, fun = NULL,
 alt1 = "*Click to start the Shiny application.*",
-alt2 = "*Click to start or [run `{run.cmd}`]({run.url}{run.arg}){{target=\"_blank\"}}.*",
+alt2 = paste0("*Click to start",
+  "or [run `{run.cmd}`]({run.url}{run.arg}){{target=\"_blank\"}}.*"),
 toc = "", toc.def = "Shiny application {app}",
 run.url = "start_rstudio.html?runrcode=", run.cmd = glue("{fun}(\"{app}\")"),
 run.arg = URLencode(run.cmd, reserved = TRUE),