Skip to content

Commit 4aa2d8a

Browse files
Minor updates to Days 1, 2
1 parent 59ed5e0 commit 4aa2d8a

2 files changed

Lines changed: 24 additions & 6 deletions

File tree

Curriculum/Day_1/day_1.qmd

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ Sam Schiano and Sophie Breitbart are contractors with ECS Federal working in sup
4646

4747
- [Day 1 communal notes doc](https://docs.google.com/document/d/1nVlmmZgp8vCHZKCMHnBm43bf-mtk7pSA1t2FLHEoyZA/edit?tab=t.0#heading=h.lwix6dbx3lr8)
4848
- Contains resources (from us and you!) and areas for note-taking
49-
- [Sample data](https://github.com/nmfs-ost/asar/blob/main/inst/extdata/Report.sso)
50-
- Sample model output data for coding demonstrations
5149

5250
::: {.callout-note appearance="minimal"}
5351
Break for questions
@@ -237,10 +235,26 @@ params:
237235

238236
Then, in the body of your report, you can reference this parameter like this:
239237

240-
"The native range of \`params\$species\` spans from..."
238+
* add a backtick (`)
239+
* add lowercase 'r'
240+
* add params + $ + the parameter itself
241+
* add a backtick (`)
241242

242-
When you knit the document, \`params\$species\` will be replaced with "Petrale sole".
243+
```{r eval=FALSE}
244+
`r params$species`
245+
```
246+
247+
Here is an example. NOTE that this example uses single quotes (') instead of backticks (`), otherwise this page won't render properly. But in your report, use the syntax directly above.
248+
249+
"The native range of 'r params$species' spans from..."
250+
251+
When you knit the document, 'r params$species' will be replaced with "Petrale sole".
243252

253+
::: {.callout-tip}
254+
To make the species name italicized, add single asterisks (*) around the phrase. For example:
255+
256+
\*'r params$species'* will render as *Petrale sole*.
257+
:::
244258

245259
### References and Bibliography
246260

@@ -305,6 +319,10 @@ Here are two entries using the examples mentioned above:
305319
You can edit the glossary by altering, adding, or removing entries in the "report_glossary.tex" file.
306320
:::
307321

322+
::: {.callout-tip}
323+
Is there an acronym we've missed that should be included in this national glossary? Make an [issue](https://github.com/nmfs-ost/asar?tab=contributing-ov-file#contributing-bugs) or, even better, a [pull request](https://github.com/nmfs-ost/asar?tab=contributing-ov-file#recommended-workflow-fork--submit-a-pull-request) with your suggestion!
324+
:::
325+
308326
#### Using acronyms in reports
309327

310328
First, check if the glossary contains your acronym; if it doesn't, you can edit the file and add it yourself.

Curriculum/Day_2/day_2.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -412,9 +412,9 @@ asar::create_template(
412412
::: {.callout-important}
413413
The console will return this question:
414414

415-
> Do you want to keep the current preamble? (Y/N)
415+
> Update the preamble to match entered arguments? (Y/N)
416416
417-
When you are rerendering your skeleton in a way that edits your preamble (e.g., when you add new model results), your answer should typically be NO (n).
417+
When you are rerendering your skeleton in a way that edits your preamble (e.g., when you add new model results), your answer should typically be YES (y).
418418

419419
Just be aware that these changes will, in fact, change your current preamble and overwrite any edits you made to that file.
420420
:::

0 commit comments

Comments
 (0)