Skip to content

Commit fa67525

Browse files
committed
Add QUARTO_KNITR_RSCRIPT_ARGS to documented environment variables
1 parent 63fe0cf commit fa67525

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

docs/advanced/environment-vars.qmd

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,21 @@ quarto render
1515

1616
You can read about other ways to set environment variables in Quarto Projects in [Environment Variables](/docs/projects/environment.qmd).
1717

18-
| Variable | Description |
19-
|-----------------|-------------|
20-
| `QUARTO_R` | Explicit path to the version of `Rscript` to be used by the `knitr` engine and `quarto run *.R` command. |
21-
| `QUARTO_PYTHON` | Explicit path to the version of `python` to be used by the `jupyter` engine and `quarto run *.py` command. |
18+
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
19+
| Variable | Description |
20+
+==============================+================================================================================================================================================+
21+
| `QUARTO_R` | Explicit path to the version of `Rscript` to be used by the `knitr` engine and `quarto run *.R` command. |
22+
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
23+
| `QUARTO_PYTHON` | Explicit path to the version of `python` to be used by the `jupyter` engine and `quarto run *.py` command. |
24+
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2225
| `QUARTO_VERSION_REQUIREMENT` | A [`semver`](https://semver.org/) string describing the Quarto version requested by the environment. If this check fails, Quarto will not run. |
26+
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
27+
| QUARTO_KNITR_RSCRIPT_ARGS | Comma separated list of command line argument to pass to `Rscript` started by Quarto when rendering with `knitr` engine, e.g. |
28+
| | |
29+
| | ``` |
30+
| | QUARTO_KNITR_RSCRIPT_ARGS="--no-init-file,--max-connections=258" |
31+
| | ``` |
32+
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2333

2434
## Variables Quarto sets
2535

@@ -46,9 +56,14 @@ ENV["QUARTO_DOCUMENT_PATH"]
4656
```
4757
:::
4858

49-
| Variable | Description |
50-
|----------------|--------------------------------------------------------|
51-
| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode |
52-
| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered |
53-
| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` |
54-
| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata |
59+
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
60+
| Variable | Description |
61+
+============================================+==========================================================================================================+
62+
| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode |
63+
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
64+
| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered |
65+
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
66+
| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` |
67+
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
68+
| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata |
69+
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)