carpentries / glosario-r

glosario create and retrieve multilingual glossaries.
https://carpentries.github.io/glosario-r
Other
6 stars 5 forks source link

Use Case - Finding lessons [Requirements Support] #9

Open ian-flores opened 4 years ago

ian-flores commented 4 years ago
  1. Amari writes a lesson in R Markdown. She adds the glossary key to its YAML metadata and indicates that the lesson requires the term correlation and defines the term regression.
  2. Beatriz is writing a lesson on linear models. She adds YAML metadata indicating that the lesson requires the term regression.
  3. To find prerequisite lessons she can recommend to her students, Beatriz runs a command-line script that:
    1. Uses rmarkdown::yaml_front_matter(filename) to reads metadata from all of the lessons she has archived.
    2. Lists all of the lessons that state they define the term regression.
ian-flores commented 3 years ago

Starting work on this issue in branch find-lessons

ian-flores commented 3 years ago

Commit 91bf636 includes the first draft of this functionality. It still lacks completeness in terms of output handling, documentation and testing but it's a good first attempt.