Output directory in quarto-cli #2171
Replies: 13 comments 38 replies
-
|
Define a project:
output-dir: results/reports/There is also the directory in which the execution happens, by default this is where the Quarto document lives, see https://quarto.org/docs/projects/code-execution.html#working-dir. Also you could use the |
Beta Was this translation helpful? Give feedback.
-
|
Thanks @mcanouil. I had already tried the _quarto.yml suggestion and (1) the output is not what is expected and (2) does not allow easy looping to generate multiple reports. Output: quarto render scripts/hello.qmd
(..)
Output created: ../results/reports/scripts/hello.htmlAs for using the quarto R package, I guess I could, but is there any advantage over using |
Beta Was this translation helpful? Give feedback.
-
|
Well, ok the for the CLI, although would the Python users want to use a Python interface (https://github.com/quarto-dev/quarto-python) rather than switching back to shell/bash or whatever? |
Beta Was this translation helpful? Give feedback.
-
|
I strongly support this request. I have a solid data-analysis workflow based on Resorting to some ad-hoc code for copying over the resulting files is cumbersome, error prone and breaks the workflow and the chain of dependencies in the pipeline. Best, |
Beta Was this translation helpful? Give feedback.
-
|
I second this! Best things is that quarto(-cli) can greatly simplify the rendering, as well as give tremendous control in a single line – which knit couldn't provide IMO. An option such as |
Beta Was this translation helpful? Give feedback.
-
|
I second this! In my case the process rendering qmd files do not have write access to the script folder (only read). So it is not able to render the qmd files in the script folder. The current workaround is to:
Hope this helps. |
Beta Was this translation helpful? Give feedback.
-
|
A more flexible option to specify the output directory would be really useful. I render a lot of ad-hoc reports that are stored in different parts of my code base, and I want the output to be stored in various sub-folders that I use to organize my results. Right now I use some minor shell scripting to put the results where I want them, but this would be greatly simplified if there were a working option to set the output directory. |
Beta Was this translation helpful? Give feedback.
-
|
Hello mcanouil. When I attempt to use I output reports from the same project into different folders in an ad-hoc manner, so I can't use a solution like _quarto.yml, since it seems that will set one output directory for all reports. It would be great to be able to specify an arbitrary output directory at the command line (I suspect that is what most people think --output-dir does in the first place). |
Beta Was this translation helpful? Give feedback.
-
|
I don't know what's your setup, but it works just fine. Edit: To be accurate, it works only as long as you do run quarto without parent directories of the Quarto document you try to render and if the quarto document lives alongside |
Beta Was this translation helpful? Give feedback.
-
|
I have been having a similar issue. I can specify an output directory child directory, but I have not gotten the output directory to be entirely at a different location. (For example I can save it to C:/~/child, but not to X:/shared_dir). In my case, I am trying to generate a report on my local machine and output it to a shared drive for my team. |
Beta Was this translation helpful? Give feedback.
-
You can't do that. Quarto we'll handle You need to have another step after your |
Beta Was this translation helpful? Give feedback.
-
|
I also am seeking the capability mentioned by others in this thread - to specify an |
Beta Was this translation helpful? Give feedback.
-
|
On a related note, I'm having a similar issue using For example, this will work: quarto::quarto_render(
input = "document.qmd",
output_file = "template.pdf"
)But this will produce an error: quarto::quarto_render(
input = "document.qmd",
output_file = file.path("pdf", "template.pdf")
)This is really unfortunate because one of the only reasons I might use Edit: A work around is to simply render these and then add another line to move the files into a folder, which is easy enough, but I still would expect that I should be able to render them into a sub folder. |
Beta Was this translation helpful? Give feedback.
-
Unfortunately this isn't working for me. I get repeat warnings of "Could not fetch resource [my-qmd-name]__files/libs/quarto-html/[random-css-and-js-file.js/css]" |
Beta Was this translation helpful? Give feedback.
-
|
Yeah I posted my original function prematurely. After further testing and improving it, I came up with |
Beta Was this translation helpful? Give feedback.
-
That was quick - thank you! Some notes: it errors if input is specified using |
Beta Was this translation helpful? Give feedback.
-
|
Thanks! Good feedback. It's not perfect. I played around with different ways to try to handle every situation, but stopped once it addressed most of my use cases. At some point the Quarto team may take this on, so I'm going to leave it to them (or if anyone else finds a better solution). |
Beta Was this translation helpful? Give feedback.
-
|
I'm not 100% happy, but here another workaround I have found. You can run a render.R script with this contents: My quarto document YAML: title: "Penguin reports"
|
Beta Was this translation helpful? Give feedback.
-
|
For anyone wondering about this issue, here is an update as of Quarto CLI v1.5.23 (pre-release), about using Quarto CLI v1.5.23
mkdir demo
echo "---\ntitle: "Untitled"\nformat: html\nembed-resources: true\n---" > demo/demo.qmd
quarto render demo/demo.qmd --output-dir output
tree
#> .
#> └── demo
#> ├── demo.qmd
#> └── output
#> └── demo.html
#>
#> 3 directories, 2 filesBut, for many reasons you can end up with a touch _quarto.yml
mkdir demo
echo "---\ntitle: "Untitled"\nformat: html\nembed-resources: true\n---" > demo/demo.qmd
quarto render demo/demo.qmd --output-dir output
tree
#> .
#> ├── _quarto.yml
#> ├── demo
#> │ └── demo.qmd
#> └── output
#> └── demo
#> └── demo.html
#>
#> 4 directories, 3 filesNote that trying to render from a sub-directory of a Quarto project will still "fail" as it will have the same result as the example above (kind of expected since Quarto resolves the root using touch _quarto.yml
mkdir demo
echo "---\ntitle: "Untitled"\nformat: html\nembed-resources: true\n---" > demo/demo.qmd
cd demo
quarto render demo.qmd --output-dir output
tree ../
#> ../
#> ├── _quarto.yml
#> ├── demo
#> │ └── demo.qmd
#> └── output
#> └── demo
#> └── demo.html
#>
#> 4 directories, 3 files |
Beta Was this translation helpful? Give feedback.
-
|
Is it possible to just put demo.html under output directory, i.e., output/demo.html, not under output/demo, i.e., output/demo/demo.html? Also, is it possible to render a qmd file that is not in current working directory. Let's say I am in a directory named analysis. It has qmd file ./demo/demo.qmd. Is it possible to run the command |
Beta Was this translation helpful? Give feedback.
-
|
No for "simple project" right now as illustrated in my message. |
Beta Was this translation helpful? Give feedback.
-
|
Got it. I will stay with file-moving scripts after rendering the qmd files. Hope Quarto team will implement this feature soon. Thank you! |
Beta Was this translation helpful? Give feedback.
-
Quarto CLI v1.7.13Single document with
|
Beta Was this translation helpful? Give feedback.
-
|
I'm not fully understanding all the options here. The only thing I have wanted to do for ages now is something like this: quarto::quarto_render(
"hello.qmd",
output_dir = "report/hello.html"
)Can that be done now? |
Beta Was this translation helpful? Give feedback.
-
|
No, output directory is still a directory at least in Quarto CLI. With the current stable version this is possible (the fact that the input document is at the same path level as where you call Quarto CLI is important, see #2171 (comment)) echo '---\ntitle: "Untitled"\nformat: html\n---' > hello.qmd
quarto render hello.qmd --output-dir report |
Beta Was this translation helpful? Give feedback.
-
|
Here is a summary with various setup and behaviours/results: https://github.com/mcanouil/quarto-issues-experiments/tree/main/quarto-cli-2171#readme |
Beta Was this translation helpful? Give feedback.
-
|
Sorry, I'm a still a bit confused. Starting with something like this:
Can I render my reports so that the end result is something like this?:
And if this is possible, do I control the output directory of each file from the corresponding .qmd file, or do I do it from the _quarto.yml file? So far I've tried adding this at the beginning of each .qmd file without luck: I use different output formats for different purposes For me it's important to be able to render to all regularly. |
Beta Was this translation helpful? Give feedback.
-
No this is not possible currently to have such granular control directly from configuring quarto CLI. You need to handle that directly using post-render script. This may become possible in the future when an important topic will be handled Right now, quarto needs to be wrapped in workflow processing tool to achieve such results (if post render script is not enough): Makefile, Just, or any others tool or scripting. |
Beta Was this translation helpful? Give feedback.
-
|
How can I render a quarto HTML report to a custom directory with a custom filename? I've read the above discussion but I don't see a solution for this yet. For example, I want to render a .qmd file's output to an absolute path (e.g. |
Beta Was this translation helpful? Give feedback.
-
|
The annoying aspect of this solution is that you have to control for all the assets used by the document, including quarto libraries, css, images or other files linked or used from within the rendered quarto document. This makes it very difficult to have a general post-processing script, because you should parse the source code to find all the dependencies. Furthermore, you have to copy these assets over to the destination, because you want to keep it at hand at the source location for interactive work, which in turn forces you to keep these dependencies synchronised manually or with some additional tool. It's quite a lot of work. And it only works in quarto projects. Otherwise you need to do it in a further script. |
Beta Was this translation helpful? Give feedback.
-
|
In our surveydown survey platform, we have a |
Beta Was this translation helpful? Give feedback.
-
|
Here is my solution :D Overall, my goal is to make parameterized quarto html reports where I can save the output
|
Beta Was this translation helpful? Give feedback.
-
|
Using |
Beta Was this translation helpful? Give feedback.
-
|
@jarbet you should avoid using The better way1: ---
params:
title: 'Title'
dataset: 'mtcars'
n.print: 5
format:
html:
embed-resources: true
---
```{r}
#| output: asis
cat(sprintf("\n\n---\ntitle: %s\n---\n\n", params[["title"]]))
```Footnotes
|
Beta Was this translation helpful? Give feedback.
-
|
Hello,
My primary use case is generating a report with a custom file name in a
custom location. It would be nice if the Quarto CLI could do this out of
the box, as this seems like an often-requested feature and makes sense from
a usability perspective. But I'm sure this is one of those features that is
easy to want but hard to implement, which is why it is unavailable.
Fortunately, I use an easy shell-based workaround, copied below (`$src` is
the project's source location, `$wd` is the working directory).
```bash
qmd=$src/my/path/myreport.qmd
fbase=${${qmd##*/}%.qmd} #Get filename without extenstion
out=$wd/reports/$fbase.html
mkdir -p ${out%/*}
quarto render $qmd
mv ${qmd%.*}.html $out
open $out
```
As Mickaël mentioned, I make the report self-contained to avoid discovering
and copying assets.
```diff
---
format:
html:
embed-resources: true
---
```
This works great for generating html reports but I don't know how it works
in other cases.
Ben Carlson, PhD
|
Beta Was this translation helpful? Give feedback.
-
|
@benscarlson Please don't reply by email if you intend to share code. Use GitHub UI and format your message properly for it to be legible. Thank you. If your code contains code blocks, you need to enclose it using more backticks, i.e., usually four |
Beta Was this translation helpful? Give feedback.
-
|
Okay great thanks for letting me know. I just updated it in GitHub, so hopefully, it is easy to read now. |
Beta Was this translation helpful? Give feedback.
-
|
Although for some reason, the code blocks are not rendering even after I updated them. |
Beta Was this translation helpful? Give feedback.
-
|
I've tried to edit your post, it must be because it's an "email" originally as the "preview" works and the same content is properly formatted below. Note that Hello, My primary use case is generating a report with a custom file name in a qmd=$src/my/path/myreport.qmd
fbase=${${qmd##*/}%.qmd} #Get filename without extenstion
out=$wd/reports/$fbase.html
mkdir -p ${out%/*}
quarto render $qmd
mv ${qmd%.*}.html $out
open $outAs Mickaël mentioned, I make the report self-contained to avoid discovering ---
format:
html:
embed-resources: true
---This works great for generating html reports but I don't know how it works Ben Carlson, PhD |
Beta Was this translation helpful? Give feedback.
-
|
Good to know, thank you! |
Beta Was this translation helpful? Give feedback.
-
(this discussion started in the Rstudio community but I got asked to move it here)
I am trying
quartoas a replacement for my Rmd-basedrmarkdown::renderworkflow to render reports into specific folders and encountered what I think is a missing feature inquarto. The usual project structure has the Rmd files in a scripts folder and then I render them to specific results folders :project_base:
I do this with:
this is particularly useful when rendering separate parametrized reports for either different datasets or arguments:
Thus generating the files:
Very flexible and part of my daily set-up.
Trying to recreate this in quarto-cli with a simple example, I thought thought the way to go was the option --output-dir:
However this places all outputs in the same directory as the qmd file (scripts/) and not in the output-dir:
A few things I tried but did not mimic the expected behaviour:
quarto createand then rendered the script withquarto render scripts/hello.qmd --output-dir results. It sort of works, but the output is sent to "results/scripts/"post-render: xcopy *_files outputis not a solution beacuse it would have to be reweiteen for every loop iteration in the example above.Christophe Dervieux mentioned that this is not planned feature and so I would like to get the discussion started.
Cheers-
Beta Was this translation helpful? Give feedback.
All reactions