src/core/report.js
The project report: one Markdown document, always in the same order, that gathers an observing project from the target to the result. It wraps markdownReportFor (system, data, fit set-up, result, reproduction) with what the session alone does not hold: the observing project (target, site, the night and event), the image reduction, the runs compared, a methods paragraph with its references, and the figures written next to it. No DOM; pure.
Import: import { … } from './src/core/report.js' — no DOM, runs in Node and the browser.
REPORT_SECTIONS
js
const REPORT_SECTIONSNo description in the source.
projectReport
js
function projectReport(session, opts = {})- param session esl-session document, with
resultwhen a fit was run - param opts { project: the site's observing project record (src/site/project.js) or null reduction: { name, frames, method, aperture_px, annulus_px, comparison, scatter, time_system, software, fwhm_px } or null runs: [{ id, label, name, logZ, err, converged, chi2, n, k }] runs on the same data, the reference first or not verdict: the analyzer's own reading of the comparison (a sentence), optional figures: [file names] written with the report (PNG), optional files: [file names] written with the report (session, BibTeX, ...), optional title, author, date (ISO) }
- returns { markdown, bibtex, keys, notes }