diff --git a/CHANGELOG.md b/CHANGELOG.md index 09c3e64..dcf3131 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning][]. [keep a changelog]: https://keepachangelog.com/en/1.0.0/ [semantic versioning]: https://semver.org/spec/v2.0.0.html +## [Unreleased] + +- Improve instruction text in quarto template to get users started more quickly ([#40](https://github.com/Boehringer-Ingelheim/dso/pull/40)) + ## v0.9.0 ### New Features diff --git a/src/dso/templates/stage/quarto/src/{{ stage_name }}.qmd b/src/dso/templates/stage/quarto/src/{{ stage_name }}.qmd index 1ec9b35..6280fd0 100644 --- a/src/dso/templates/stage/quarto/src/{{ stage_name }}.qmd +++ b/src/dso/templates/stage/quarto/src/{{ stage_name }}.qmd @@ -5,18 +5,29 @@ require(conflicted) require(dso) ``` +Load the stage-specific 'params.yaml' config using the `read_params(..)` function. This function specifically loads +only the stage-dependent parameters that are defined in the 'params' section of the 'dvc.yaml' file. + ```{r} #| label: read_params -# read_params sets the stage directory, runs 'dso compile-config' -# and loads params defined in the 'dvc.yaml' 'params' section of the stage params <- read_params("{{ stage_path }}") ``` +When modifying the 'dvc.yaml', 'params.in.yaml', or 'params.yaml' files during development, use the 'reload(params)' +function to ensure proper application of the changes by rebuilding and reloading the configuration. + +```{r} +#| label: reload_params + +reload(params) +``` + +To locate your files relative to the stage path use `stage_here(..)`. + ```{r} #| label: obtain_files_relative_to_stage_dir -# stage_here locates your files relative to the stage path set in read_params # e.g. samplesheet <- readr::read_csv(stage_here(params$samplesheet)) ```