Write from your data
Keep analysis inputs, scripts, tables, and manuscript results connected.
A results paragraph is easier to trust when the calculation behind it is nearby. Use a research project to keep the analysis procedure and its outputs alongside the manuscript.
Set up the project
Section titled “Set up the project”Choose the Reproducible analysis starter. Link the data folder so the research tools can read the original measurements without moving them into the paper.
Record what the columns mean, their units, and any exclusions before asking for an analysis.
Give the assistant a bounded job
Section titled “Give the assistant a bounded job”Use /oleafly-data-analysis or an Analysis research task:
Read the measurements in the linked Data folder. Compare the two conditions using the method in analysis-plan.md. Save the script, a table with units, and a note describing exclusions. Keep the input data unchanged.
Analysis scripts require the relevant local runtime and libraries. Have the assistant check those requirements and save how to rerun the work.
Inspect the outputs
Section titled “Inspect the outputs”Read the script and confirm that the selected data and method match the question. Check units, sample counts, missing values, and uncertainty before accepting a result.
Keep tables and figures with their generation scripts. The figure-prep skill can help turn a checked result into a figure for the manuscript.
With a CLI agent, the Reproducibility audit starting point asks what each result still needs to be reproduced: code, data, software versions, random seeds and build instructions. Figure audit checks captions, labels, axis units and readability. Both ask the agent to write a report in research/ and leave the manuscript alone.
Run the code inside the document
Section titled “Run the code inside the document”To have the numbers in the PDF come straight from the code, write the report in Quarto or Calepin. Quarto runs R, Python or Julia chunks in a .qmd or .Rmd file, and Calepin runs chunks in a Typst document.
- Code stays off in each project until you choose Allow code in this project. With code off, Quarto shows each chunk’s code without its output, and Calepin shows the results it stored the last time code ran. Filters, shortcodes, an
_extensionsfolder, render scripts and inline R code run code even then, so a project that uses any of them won’t compile until you allow code. - With code off and no R on the computer, a
.qmdfile with front matter still previews, unless its front matter has aknitr:key. Any other document with R code,.Rmdfiles included, needs R even with code off. Install R from cloud.r-project.org (opens in a new tab), then compile again. - Oleafly needs Quarto 1.5 or newer. If yours is older, Oleafly uses its own copy, or asks you to download one from Settings → Engines → Quarto. With no copy downloaded, a document in a
_quarto.ymlproject builds with your older Quarto instead. - Python code runs in the project’s own environment when the project has a
.venv,venvorenvfolder with Jupyter installed, and Calepin uses a.venvfolder when the project has one. Otherwise the code runs in the Python listed under Languages in Settings → Engines → Quarto. - A
pdforbeamerdocument needs LaTeX. With no TeX installed, install TinyTeX when Oleafly offers it, switch the document toformat: typst, or addpdf-engine: tectonicto the front matter to use the built-in engine once code is allowed. - Quarto writes a working file with the document’s name next to it:
report.texfor a PDF, orreport.typfor Typst. If a file of yours already has that name, the compile stops and names it instead of replacing it. Rename or move your file, then compile again. - If Korean, Chinese or Japanese characters are missing from the PDF, the warning names a font and gives two lines to add to the front matter:
CJKmainfont:with that font, andpdf-engine: tectonic. Add both, because the font comes with the built-in engine.pdf-engine: tectonicworks only once code is allowed for the project. - A notebook can run for up to an hour. Past that, Oleafly stops it, and the log shows the cell it reached. Shorten or cache that cell, then compile again.
Write the result
Section titled “Write the result”Ask the assistant to draft a results passage using only the reviewed outputs. Inspect each number against the table and keep the method distinct from the interpretation.
Compile the document and review the complete table or figure in the PDF, including labels and caption.