A2CPS Starter Kits

To Update

The following is a minimal workflow for updating the site.

• Make changes to the relevant files (e.g., *qmd, references.bib).
• Render book (docs)

# cd [path to starterkits] 
$ quarto render

• Record changes with git

# confirm nothing unexpected
$ git diff

# modify as needed to record expected changes
$ git add *qmd _book

# please add a more informative message (that is still short)
$ git commit -m "Update book"

• Push changes to the remote

$ git push

• On GitHub, trigger the action "Deploy static content to Pages"

Tips

Quarto

To view changes, use quarto preview, which renders the qmd files into html, opens up a copy of the starter kits in a browser, and automatically re-renders files when changes are saved.

Template

This repo comes with a template for new kits: _template.qmd.

Tables

By default, all tables are rendered into markdown with knitr::kable¹, which will attempt to render the entire table. For tables larger than a few rows, this is likely not what is wanted; adding many rows will make the website very large and slow, and we do not want to accidentally share an entire dataset. Here are three options to consider, in no particular order

• For an individual *qmd, change the default formatter to something that prints only a few rows
  • For example, freesurfer.qmd
  • For a list of options, see: https://quarto.org/docs/reference/formats/html.html#tables
• Manually print individual tables using a different formatter
  • For example, DT
• Print only a part of of the table
  • For example, head(df) instead of df

Resources

• Quarto Books
• GitHub Pages

Footnotes

1. The default table formatting configured in _quarto.yml. ↩