Пишіть на основі своїх даних
Тримайте вхідні дані аналізу, скрипти, таблиці та результати рукопису пов’язаними.
Абзац із результатами викликає більше довіри, коли обчислення, що стоять за ним, лежать поруч. Використовуйте дослідницький проєкт, щоб тримати процедуру аналізу та її результати поруч із рукописом.
Налаштуйте проєкт
Розділ «Налаштуйте проєкт»Виберіть стартовий шаблон Відтворюваний аналіз. Пов’язіть теку з даними, щоб дослідницькі інструменти могли читати початкові вимірювання, не пересуваючи їх у рукопис.
Запишіть, що означають стовпці, їхні одиниці вимірювання та будь-які виключення, перш ніж просити аналіз.
Дайте асистентові обмежене завдання
Розділ «Дайте асистентові обмежене завдання»Використайте /oleafly-data-analysis або дослідницьке завдання типу Аналіз:
Прочитайте вимірювання у пов’язаній теці Data. Порівняйте дві умови методом із analysis-plan.md. Збережіть скрипт, таблицю з одиницями вимірювання та нотатку з описом виключень. Не змінюйте вхідні дані.
Скрипти аналізу потребують відповідного локального середовища виконання та бібліотек. Нехай асистент перевірить ці вимоги та збереже спосіб повторного запуску роботи.
Огляньте результати
Розділ «Огляньте результати»Прочитайте скрипт і переконайтеся, що відібрані дані та метод відповідають питанню. Перевірте одиниці вимірювання, кількості вибірок, пропущені значення та невизначеність, перш ніж прийняти результат.
Тримайте таблиці й рисунки разом зі скриптами, які їх створюють. Навичка figure-prep допоможе перетворити перевірений результат на рисунок для рукопису.
Із агентом командного рядка стартова точка Перевірка відтворюваності запитує, чого кожному результату бракує для відтворення: код, дані, версії програмного забезпечення, випадкові початкові значення й інструкції збірки. Перевірка рисунків перевіряє підписи, мітки, одиниці на осях і читабельність. Обидві просять агента написати звіт у research/ і не чіпати рукопис.
Запускайте код усередині документа
Розділ «Запускайте код усередині документа»Щоб числа в PDF походили просто з коду, пишіть звіт у Quarto або Calepin. Quarto запускає фрагменти R, Python чи Julia у файлі .qmd або .Rmd, а Calepin запускає фрагменти в документі Typst.
- Код у кожному проєкті лишається вимкненим, доки ви не виберете Дозволити запуск коду в цьому проєкті. Коли код вимкнено, Quarto показує код кожного фрагмента без його виводу, а Calepin показує результати, які зберіг під час останнього запуску коду. Фільтри, шорткоди, тека
_extensions, скрипти рендерингу та вбудований код R запускають код навіть тоді, тож проєкт, що використовує будь-що з цього, не компілюватиметься, доки ви не дозволите код. - Коли код вимкнено і на комп’ютері немає R, файл
.qmdіз front matter усе одно показується в перегляді, якщо в його front matter немає ключаknitr:. Будь-який інший документ із кодом R, зокрема файли.Rmd, потребує R навіть при вимкненому коді. Встановіть R із cloud.r-project.org (відкривається в новій вкладці), а потім скомпілюйте знову. - Oleafly потребує Quarto 1.5 або новішого. Якщо ваш старіший, Oleafly використовує власну копію або просить завантажити її в Налаштування → Рушії → Quarto. Якщо копію не завантажено, документ у проєкті
_quarto.ymlнатомість збирається вашим старішим Quarto. - Код Python запускається у власному середовищі проєкту, коли проєкт має теку
.venv,venvабоenvзі встановленим Jupyter, а Calepin використовує теку.venv, коли проєкт її має. Інакше код запускається в Python, указаному в розділі Мови в Налаштування → Рушії → Quarto. - Документ
pdfабоbeamerпотребує LaTeX. Якщо TeX не встановлено, встановіть TinyTeX, коли Oleafly це пропонує, переведіть документ наformat: typstабо додайтеpdf-engine: tectonicдо front matter, щоб використати вбудований рушій, щойно код дозволено. - Quarto записує поруч робочий файл з іменем документа:
report.texдля PDF абоreport.typдля Typst. Якщо ваш файл уже має таке ім’я, компіляція зупиняється й називає його, а не замінює. Перейменуйте або перенесіть свій файл, а потім скомпілюйте знову. - Якщо в PDF бракує корейських, китайських чи японських символів, попередження називає шрифт і дає два рядки для front matter:
CJKmainfont:із цим шрифтом іpdf-engine: tectonic. Додайте обидва, бо шрифт постачається з вбудованим рушієм.pdf-engine: tectonicпрацює, лише коли для проєкту дозволено код. - Зошит може працювати до години. Після цього Oleafly зупиняє його, а журнал показує комірку, до якої він дійшов. Скоротіть або закешуйте цю комірку, а потім скомпілюйте знову.
Напишіть результат
Розділ «Напишіть результат»Попросіть асистента написати уривок із результатами, користуючись лише оглянутими результатами. Звірьте кожне число з таблицею і не змішуйте метод з інтерпретацією.
Скомпілюйте документ і перегляньте повну таблицю або рисунок у PDF, включно з мітками та підписом.