How can I use a Quarto variable to include a code block?

[hugo-pires]

Description

I am trying to de-clutter a Quarto markdown document, using variables to include code blocks. I've created a _variables.yml file with

view:
    arvores: |
    {python}
    #| echo: false
    #| label: tbl-test
    #| tbl-cap: Volumes
    Markdown(tabulate(data,headers=data.columns,showindex=False))

with the following code in the report.qmd file:

{{< var view.arvores >}}

But the code is not executed. Is it possible to do this? Do I need to escape any character? Would it be easier to use Quarto includes instead of variables? Nevertheless it would be more convenient to use variables, since it will allow to store multiple code chunks in a single .yaml file

Thank you

[mcanouil]

I believe you want to store your code cell in a Quarto document and use the include shortcode which is the tool to include and evaluate, see https://quarto.org/docs/authoring/includes.html.

For more, please provide a complete and small reproducible example to work with, i.e., a complete Quarto document or a Git repository.

You can share a Quarto document using the following syntax, i.e., using more backticks than you have in your document (usually four ````).

````qmd
---
title: "Reproducible Quarto Document"
format: html
---

This is a reproducible Quarto document using `format: html`.
It is written in Markdown and contains embedded R code.
When you run the code, it will produce a plot.

```{r}
plot(cars)
```

The end.
````

[hugo-pires]

Thank you for your response

the _variable.yaml has the following code

view:
    arvores: |
    {python}
    #| echo: false
    #| label: tbl-test
    #| tbl-cap: Volumes
    Markdown(tabulate(data,headers=data.columns,showindex=False))

and the document.qmd has the following code:

# Volume

{{< var view.arvores >}}

[mcanouil]

Your code cell is not even a code cell.

Your file should at least looks like:

view:
  arvores: |
    ```{python}
    #| echo: false
    #| label: tbl-test
    #| tbl-cap: Volumes
    Markdown(tabulate(data,headers=data.columns,showindex=False))
    ```

[hugo-pires]

Thank you. I was not using back-ticks after reading YAML documentation. Nevertheless, this option print out the code, but doesn execute it.

[mcanouil]

This was expected as variables is intended for static elements currently.
I am not sure the shortcode results is exposed to the engine when it enters in action.

[cderv]

Would it be easier to use Quarto includes instead of variables?

I do believe it would be easier to use include feature for this as it is easier to write pieces of markdown in other .qmd file

Also I am not sure shortcode handler like variables support yet Blocks like you would like to use. Following this issue for more:

• Shortcode handlers should respond to context; inline vs block vs code #5110

Also related to

• Capture context of shortcode invocation #1644

[hugo-pires]

Thank you. When I try your solution, the code is executed, but the cell code still appears in spite of the echo: false option. The result table is also not properly formatted.

[cderv]

When I try your solution

I believe you mean using include ? It would be a lot easier if you share a complete reproducible example when you reply something is not working. It was reminded to you earlier at #6768 (comment)

Here what I tested

• index.qmd

---
title: "Hello World"
---

```{python}
from tabulate import tabulate
from IPython.display import Markdown
```


# content

{{< include _codeblock.qmd >}}

• _codeblock.qmd

```{python}
#| echo: false
#| label: tbl-test
#| tbl-cap: Volumes
table = [["Sun",696000,1989100000],["Earth",6371,5973.6], ["Moon",1737,73.5],["Mars",3390,641.85]]
Markdown(tabulate(table))
```

Results: quarto render index.qmd

echo: false works, and table is correctly formatted

With latest Quarto 1.4

So include shortcode works

[hugo-pires]

Thank you, once again

[cscheid]

The technical reason that what you're trying to do doesn't work is that the resolution of {{< var ... >}} shortcodes happens in Lua, inside Pandoc, and that happens after engine execution.
{{< include ... >}} shortcodes, on the other hand, are special in that they're resolved before engine execution, precisely so that included files can have executable code cells.

(Yes, we should have better documentation on this. We're working on it!)

[hugo-pires]

Thanks a lot