Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update {{ stage_name }}.qmd #33

Merged
merged 2 commits into from
Oct 17, 2024
Merged

Update {{ stage_name }}.qmd #33

merged 2 commits into from
Oct 17, 2024

Conversation

tschwarzl
Copy link
Contributor

Added descriptive comments to clear up the functionality of read_params and stage_here for beginners with dso.

It is important to mention the relation between read_params and dvc.yaml for beginners to clear up that parameters have to be specified there.

added descriptive comments to clear up the functionality for beginners with dso
@tschwarzl tschwarzl requested a review from grst October 16, 2024 16:17
@@ -1,14 +1,22 @@
```{r}
library(conflicted)
library(dso)
#| label: load libraries
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think label should not contain spaces as it will be a hyperlink anchor, see https://quarto.org/docs/reference/cells/cells-knitr.html#attributes

Not sure we need labels at all here?

Copy link
Contributor Author

@tschwarzl tschwarzl Oct 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

label can contain spaces, but yes, we can remove spaces.

labels are good practice, as it shows progress in compilation, also it can be used for referencing block dependencies (spaces are there no problem). it would be good to have show good practice in the template

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I dislike them because I forget to change them when I copy&paste a block and then compilation fails because of duplicate labels. But I agree in an ideal world one would use them.

@tschwarzl tschwarzl requested a review from grst October 17, 2024 10:32
@grst grst merged commit 1f9d953 into main Oct 17, 2024
2 checks passed
@grst grst deleted the dev-template branch October 17, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants