Section B.9 Checklist
When creating an R Markdown document, have you:
-
[ ] Chosen the appropriate output format (HTML, PDF, or Word) based on how the document will be shared?
-
[ ] Clearly defined the YAML metadata (title, author, date, output)?
-
[ ] Written narrative text that explains why the analysis is being done, 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?
-
[ ] Verified that the document knits successfully from top to bottom without errors?
-
[ ] Checked that all tables and figures are readable and appropriately formatted?
-
[ ] Added captions to tables (
kable()) and figures (fig.cap) where explanation is helpful? -
[ ] Avoided printing unnecessary output (e.g., overly large tables or intermediate objects)?
-
[ ] Used text formatting (bold, italics, lists, quotes) intentionally to guide the reader?
-
[ ] Asked: Could someone unfamiliar with this analysis understand the results by reading this document alone?
