Section 10.9 Checklist
When creating a Quarto document, have you:
-
[ ] Selected an appropriate output format (HTML, PDF, or Word) based on how the document will be shared?
-
[ ] Clearly defined document metadata in the YAML (title, author, date, output)?
-
[ ] Written narrative text that explains why analytical decisions were made, not just what the code does?
-
[ ] Organized the document into logical sections using headers (
#,##,###)? -
[ ] Named your R chunks clearly so their purpose is easy to understand?
-
[ ] Loaded all required packages within the document to ensure reproducibility?
-
[ ] Confirmed that the document renders successfully from top to bottom without errors?
-
[ ] Checked that all tables and figures are readable and appropriately formatted?
-
[ ] Added informative captions to tables (
tbl-cap) and figures (fig-cap) where explanation is helpful? -
[ ] Utilized cross-references (@) for sections, tables, and figures to help the reader navigate the document?
-
[ ] Avoided displaying unnecessary or distracting output (e.g., very large tables or intermediate objects)?
-
[ ] Used text formatting (bold, italics, lists, quotes) intentionally to guide the reader?
-
[ ] Asked yourself: Could someone unfamiliar with this project understand the analysis by reading this document alone?
