get_solutions: Gather solutions from the XML body of a carpentries lesson

In carpentries/pegboard: Explore and Manipulate Markdown Curricula from the Carpentries

Gather solutions from the XML body of a carpentries lesson

Description

This will search an XML document for a solution marker and extract all of the block quotes that are ancestral to that marker so that we can extract the solution blockquotes from the carpentries lessons.

Usage

get_solutions(body, type = c("block", "div", "chunk"), parent = NULL)

Arguments

body	the XML body of a carpentries lesson (an xml2 object)
type	the type of element containing the solutions "block" is the default and will search for all of the blockquotes with liquid/kramdown markup, "div" will search for all div tags with class of solution, and "chunk" will search for all of code chunks with the engine of solution.
parent	the outer block containing the solution. Default is a challenge block, but it could also be a discussion block.

Value

• type = "block" (default) an xml nodelist of blockquotes

• type = "div" a list of xml nodelists

• type = "chunk" an xml nodelist of code blocks

Note

• the parent parameter is only valid for the "block" (default) type

• the "chunk" type has the limitation that solutions are embedded within their respective blocks, so counting the number of solution elements via this method may an undercount

Examples

loop <- Episode$new(file.path(lesson_fragment(), "_episodes", "14-looping-data-sets.md"))
get_solutions(loop$body, "block")
get_solutions(loop$unblock()$body, "div")
loop$reset()
get_solutions(loop$use_dovetail()$unblock()$body, "chunk")

carpentries/pegboard documentation built on Nov. 13, 2024, 8:53 a.m.