Skip to content

Commit

Permalink
update possible problems and comment section for getting started tuto…
Browse files Browse the repository at this point in the history
…rial number 2 ("Computations")
  • Loading branch information
FlorianPargent committed Sep 9, 2024
1 parent f12d6ab commit 1fcd417
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions get-started_2.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,16 @@ Now you can start the second tutorial at <https://quarto.org/docs/get-started/co

- Whenever you copy something from the tutorial website into your own *.qmd* document, always make sure that in RStudio you copy into *Source* mode instead of *Visual* mode. Otherwise, rendering the document will not work correctly because the visual mode adds some extra characters that brake the markdown syntax.

- The tutorial discusses yaml options (e.g. `df-print: paged`) on how to display data.frames but does not actually print any data.frame in the *.qmd* document. You can add the following chunk to test the different `df-print` options:
- [Code Linking](https://quarto.org/docs/get-started/computations/rstudio.html#code-linking) (`code-link: true`) does not always work on all systems but we do not know why.

- The tutorial discusses yaml options (e.g. `df-print: paged`) on how to display [Data Frames](https://quarto.org/docs/get-started/computations/rstudio.html#data-frames) but does not actually print any data.frame in the *.qmd* document. You can add the following chunk to test the different `df-print` options:
```{r}
#| echo: fenced
library(palmerpenguins)
penguins
```

- Code linking (`code-link: true`) sometimes does not seem to work on all systems, we also do not know why...
- The section on [Inline Code](https://quarto.org/docs/get-started/computations/rstudio.html#inline-code) mentions both the `` `{r} ` `` and `` `r ` `` syntax. If you plan to use Quarto mostly with R or are already familiar with Rmarkdown/knitr, we recommend using the `` `r ` `` syntax which is more intuitive in more advanced use cases. If you encounter some unexpected behavior, read the documentation [here](https://quarto.org/docs/computations/inline-code.html). The most important difference is that `` `r ` `` treats the output as markdown code while `` `{r} ` `` treats the output as ordinary text.

- When you render the final .qmd document, this will produce an html file (*computations.html*) that you might want to share with some colleagues to show them your new analysis. However, be aware that the html file does not contain all necessary content and will possibly not display correctly on its own. To produce a single standalone .html file that you can share with others, add `embed-resources: true` to the html options in the YAML header. The final .html then should look something like this (there is also an additional option `self-contained-math: true` which tries to make sure that all your equations can be displayed without a connection to the internet):

Expand Down

0 comments on commit 1fcd417

Please sign in to comment.