Skip to main content

Assignment 9 and M3

Where This Fits

This page connects Week 10 class work to Assignment 9 and M3: Project Update. It does not add new deliverables. It explains how the same work can support both.

A9 Submission Files

Each A9 file goes in assignments/assignment09-reporting/submission/.

report.qmd

A rerunnable Quarto report with question, data, methods, results, limitations, citations, and AI-use or audit notes.

  • Verify: render from the repository root or clearly documented project folder.

To render it, always name the file, for example: quarto render assignments/assignment09-reporting/submission/report.qmd.

TipHow to render: the course default

  1. Open the .qmd file you want to render, then open the Command Palette (View → Command Palette, or press Ctrl+Shift+P on Windows/Linux / Cmd+Shift+P on Mac) and run Quarto: Render Document. The Quarto extension renders the file and opens a preview pane.

  2. Always-works fallback (terminal): type the render command with the file’s path as shown in the Explorer, for example:

    quarto render practice_report.qmd

    Always name the file — a bare quarto render rebuilds the whole project and takes much longer.

  3. If you see a Render (or Preview) button in the editor toolbar, it does the same thing as step 1.

Where did the output go? Watch the render log for the Output created: line — it names the exact .html file created. By default the file appears next to your .qmd; in projects that set an output directory (like this book’s docs/ folder), it appears there instead. If no preview opened automatically, find that .html file in the Explorer, right-click it, and choose Download to open it in your browser (or Open Preview if available).

report.html

The rendered report.

After rendering, open the HTML file in browser preview. Confirm that the title, table, figure, citations, limitations, and references appear correctly before committing your work.

Yes, commit this HTML file. The course rule is simple: when an assessment explicitly lists a rendered artifact, commit it with its source.

  • Verify: table, figure, citations, and limitations appear.

references.bib

Bibliography entries used by the report. This may be a copied subset of the project bibliography if that makes the submission easier to inspect.

  • Verify: citations resolve during render.

outputs/

Use this folder only if your report writes external files such as CSV tables or exported figures.

  • Verify: outputs are generated by code, not manually edited.

publishing-checklist.md

Record either the private preview route or the public publishing route. Private preview is the default unless public sharing is safe.

grounding-audit.md

Trace at least three claims to evidence. Use report03 as the model.

m3-update-note.md

State what is ready for project update review and what feedback would help most.

ai-use-note.md

Name what AI helped with and how the group checked the result.

Edit These, Not Those

Edit the source .qmd and supporting text files. Do not manually edit generated HTML files, cached outputs, raw data, credentials, .RData workspaces, or system/configuration files unless instructed.

  • Edit: report.qmd, references.bib, and the notes (publishing-checklist.md, grounding-audit.md, m3-update-note.md, ai-use-note.md).
  • Do not hand-edit: report.html (re-render instead), files in outputs/ (regenerate them from code), raw data files, and configuration files such as _quarto.yml.

M3 Submission Files

M3 uses milestones/m3-project-update/submission/.

The A9 report draft can support M3:

A9 artifact M3 connection
report.qmd report-draft.qmd
report.html report-draft.html
publishing-checklist.md reproducibility-note.md
grounding-audit.md evidence for feedback-request.md
dashboard preview from A7 dashboard-preview.md

Groups may reuse work, but the files should be placed in the required folders with the required names.

For M3, place the report draft and dashboard-style KT product in the locations listed below so peers can find both during review:

  • Report draft: milestones/m3-project-update/submission/report-draft.qmd and report-draft.html.
  • Dashboard/KT product: the retained A7 source is assignments/assignment07-dashboard/submission/dashboard.qmd. Then milestones/m3-project-update/submission/dashboard-preview.md points reviewers to that source plus its screenshot or rendered-preview path. A static preview is enough; a live dashboard is not required.

Feedback Request

A useful M3 feedback request is specific:

  • Is the main claim supported by the table and figure?
  • Is the audience clear?
  • Is the limitation strong enough?
  • Would the dashboard preview help the intended audience?
  • What reproducibility issue should be fixed before Week 11?

Before Submitting

Before rendering for submission, search your code for local paths such as /Users/, C:\, Downloads, or Desktop. Replace them with project-relative paths. The Search panel (the magnifying glass icon in the left sidebar) checks every file at once.

Before committing, check the staged files. If you see raw row-level data, credentials, .RData, OS junk, or generated files that are not allowed, unstage them and check .gitignore before syncing. The full pre-commit privacy checklist is on the Private Preview page.

Check:

  • report renders;
  • table and figure are code-generated;
  • citations resolve;
  • preview route is private unless public-safe;
  • M3 feedback request names the decisions that still need review;
  • all required files are committed and synced.