quarto-dev / quarto-dev/quarto-cli
[epic] Improved API for computation parameters
Open
Nobody has claimed this yet.
epic
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 41
Description
Currently there is no single API for parametrized report. https://quarto.org/docs/computations/parameters.html
- Jupyter leverages papermill and requires a specific in-chunk syntax
- Knitr leverage R Markdown / Knitr params and requires YAML header definition in the document iself
quarto render --execute-params has YAML file support for both though,
Related
To reorganize
- https://github.com/quarto-dev/quarto-cli/issues/1189
- https://github.com/quarto-dev/quarto-cli/issues/3663
- https://github.com/quarto-dev/quarto-cli/issues/7785
- https://github.com/quarto-dev/quarto-r/issues/168
- https://github.com/quarto-dev/quarto-cli/discussions/9107
Slightly related if we decide to keep params as a metadata
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the computation parameters documentation and the quarto render --execute-params entry point, then review related issues 1189, 3663, 7785, and the linked Quarto R issues. Done means defining and implementing a single parameter API that works consistently for Jupyter and Knitr.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter, yaml
- Domain
- backend-api-design, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100