Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coatless-quarto/assign
Quarto extension for improving homework problem designs and implementations through a single document authoring scheme
https://github.com/coatless-quarto/assign
lua quarto quarto-extension teaching
Last synced: 5 days ago
JSON representation
Quarto extension for improving homework problem designs and implementations through a single document authoring scheme
- Host: GitHub
- URL: https://github.com/coatless-quarto/assign
- Owner: coatless-quarto
- Created: 2023-06-06T16:43:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-27T23:18:59.000Z (4 months ago)
- Last Synced: 2024-12-14T00:08:19.717Z (9 days ago)
- Topics: lua, quarto, quarto-extension, teaching
- Language: Lua
- Homepage: http://quarto.thecoatlessprofessor.com/assign/
- Size: 624 KB
- Stars: 6
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
> [!NOTE]
>
> We're working on getting a processed `.qmd` file placed into the output directory.
# `assign`: Authoring Homework Assignments and Solutions
Quarto extension for designing homework assignments and solutions in a single document.
This is the modernization of the [`assignr`](https://github.com/r-assist/assignr) _R_ package.
## Installing
You can install the extension and receive a preset project by typing into *Terminal*:
```bash
quarto use template coatless-quarto/assign
```
This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.
To activate the extension, add the `assign` filter to the assignment's `.qmd` file header
or to the filter list for the quarto project (e.g. in `_quarto.yml`):
```yaml
title: "Assignment 1"
filters:
- assign
```
## Using
The extension takes a single document and creates three different outputs:
- `assign/`: Student facing assignment details.
- `solution/`: Solutions without any directions.
- `rubric/` (Optional): Solutions alongside of grading criteria
To achieve this feat, the extension uses custom class names and hides content depending on the [Quarto profile](https://quarto.org/docs/projects/profiles.html) being displayed. We current recognize the following custom class names:
- `.direction`: shown in the assignment, but not the solution or rubric documents.
- `.sol`: shown in the solution and rubric documents.
- `.rubric`: shown only in the rubric version of the solutions.
In a Quarto document, this would look like:
````markdown
This text will appear across all versions of the document
:::{.direction}
Only display the directions content in the assignment document
:::
:::{.sol}
Only display the answer in the solution or rubric documents
:::
:::{.rubric}
Only display the grading notes in the rubric document.
:::
````
> [!IMPORTANT]
>
> When authoring documents, there is no need to use all custom classes
> or profiles. At any time you can omit using a class or profile if it
> is not required by your usage scenario.
## Example
For an example of each custom class, please see the [template.qmd](template.qmd) file for a demo assignment.
You can render documents under the desired profile by typing into Terminal:
```sh
quarto render --profile assign
quarto render --profile solution
quarto render --profile rubric
```
> [!NOTE]
>
> We've inquiried about allowing for project profile options to be selected under the [Render button in RStudio](https://github.com/rstudio/rstudio/issues/13679), but our issue went unanswered and was marked as stale.
> We've just filed a request for Quarto's [VS Code extension](https://github.com/quarto-dev/quarto/issues/459).
Please note, you must have the necessary Quarto project profile present to correctly receive output in the relevant directories, e.g.
`_quarto-assign.yml`
```sh
project:
output-dir: assign
```
`_quarto-solution.yml`
```sh
project:
output-dir: solution
```
`_quarto-rubric.yml`
```sh
project:
output-dir: rubric
```
You can specify a default profile like `assign` to run by adding into the main `_quarto.yml`:
```sh
profile:
default: assign
```