Skip to content

Allow messages about tables when running create_template() #431

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.

Sign up for GitHub

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

Open
sbreitbart-NOAA wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Allow messages about tables when running create_template() #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e8aa7b6
Update a11y guide with info about how to escape special characters in…
sbreitbart-NOAA Feb 16, 2026
a6e60f2
Update readme example create_template() arg from 'author' to 'authors'
sbreitbart-NOAA Feb 16, 2026
1b56a41
Allow messages in create_template() stating if tables aren't found, a…
sbreitbart-NOAA Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions R/create_template.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,9 +616,9 @@ create_template <- function(
subdir = subdir,
tables_dir = tables_dir
)
} |>
suppressMessages() |>
suppressWarnings()
} # |>
# suppressMessages() |>
# suppressWarnings()
} else {
# extract name for tables.qmd from report folder
tables_doc_name <- list.files(file_dir, pattern = "tables.qmd")
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ asar::create_template(
species = "Petrale sole",
spp_latin = "Eopsetta jordani",
year = 2023,
author = c("Ian G. Taylor"="NWFSC", "Vladlena Gertseva"="NWFSC", "Nick Tolimieri"="NWFSC"),
authors = c("Ian G. Taylor"="NWFSC", "Vladlena Gertseva"="NWFSC", "Nick Tolimieri"="NWFSC"),
include_affiliation = TRUE,
simple_affiliation = FALSE,
param_names = c("nf","sf"),
Expand Down
2 changes: 2 additions & 0 deletions vignettes/accessibility_guide.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,8 @@ recruitment_alt_text <- new_alt_text

3. As stated earlier, if you see text that looks like a placeholder (e.g., "The x axis, showing the year, spans from B.start.year to B.end.year..."), that means that there was at least one instance where our tool failed to extract a specific value from the model results and substitute it into the placeholder. Please make sure that your alt text and captions contain the expected values before moving forward with your report. Check out the inst/resources/captions_alt_text_template.csv file in the `stockplotr` package to view the template with placeholders. The same package's `write_captions()` function shows how values are extracted from the model results and substituted into the placeholders.

4. If you add a special character (e.g., percentage sign (%) or dollar sign ($); see [full list on this wiki page](https://en.wikibooks.org/wiki/LaTeX/Special_Characters#Other_symbols)), please add two backslashes before the character to avoid issues compiling your report later on (specifically, the conversion from Quarto to LaTeX via Pandoc, and then compilation of the LaTeX report after running `add_accessibility()` or `add_alttext()`). For example, "The 95% CI" would be written as "The 95\\\\% CI".

### More resources

Looking for more resources for writing alt text? Check out the [NOAA Library's website for creating accessible documents](https://library.noaa.gov/Section508/CreatingDocs).
Expand Down
Loading