Escreva a partir dos seus dados
Mantenha entradas de análise, scripts, tabelas e resultados do manuscrito conectados.
Um parágrafo de resultados inspira mais confiança quando o cálculo por trás dele está por perto. Use um projeto de pesquisa para manter o procedimento de análise e as saídas dele junto ao manuscrito.
Configure o projeto
Seção intitulada “Configure o projeto”Escolha o iniciador Análise reprodutível. Vincule a pasta de dados para que as ferramentas de pesquisa consigam ler as medições originais sem movê-las para dentro do artigo.
Registre o que as colunas significam, as unidades delas e quaisquer exclusões antes de pedir uma análise.
Dê ao assistente um trabalho delimitado
Seção intitulada “Dê ao assistente um trabalho delimitado”Use /oleafly-data-analysis ou uma tarefa de pesquisa de Análise:
Leia as medições na pasta Dados vinculada. Compare as duas condições usando o método de analysis-plan.md. Salve o script, uma tabela com unidades e uma nota descrevendo as exclusões. Mantenha os dados de entrada inalterados.
Scripts de análise exigem o runtime local e as bibliotecas relevantes. Peça ao assistente que confira esses requisitos e salve como rodar o trabalho de novo.
Inspecione as saídas
Seção intitulada “Inspecione as saídas”Leia o script e confirme que os dados e o método selecionados correspondem à pergunta. Confira unidades, contagens de amostras, valores ausentes e incerteza antes de aceitar um resultado.
Mantenha tabelas e figuras junto dos scripts que as geraram. A habilidade figure-prep pode ajudar a transformar um resultado conferido em uma figura para o manuscrito.
Com um agente de CLI, o ponto de partida Auditoria de reprodutibilidade pergunta o que cada resultado ainda precisa para ser reproduzido: código, dados, versões de software, sementes aleatórias e instruções de compilação. A Auditoria de figuras confere legendas, rótulos, unidades dos eixos e legibilidade. Os dois pedem ao agente que escreva um relatório em research/ e deixe o manuscrito em paz.
Execute o código dentro do documento
Seção intitulada “Execute o código dentro do documento”Para que os números do PDF venham direto do código, escreva o relatório em Quarto ou Calepin. O Quarto executa blocos de R, Python ou Julia em um arquivo .qmd ou .Rmd, e o Calepin executa blocos em um documento Typst.
- O código fica desligado em cada projeto até você escolher Permitir código neste projeto. Com o código desligado, o Quarto mostra o código de cada bloco sem a saída dele, e o Calepin mostra os resultados que guardou na última vez que o código rodou. Filtros, shortcodes, uma pasta
_extensions, scripts de renderização e código R inline executam código mesmo assim, então um projeto que usa qualquer um deles não compila até você permitir código. - Com o código desligado e sem R no computador, um arquivo
.qmdcom front matter ainda tem prévia, a menos que o front matter tenha uma chaveknitr:. Qualquer outro documento com código R, arquivos.Rmdincluídos, precisa do R mesmo com o código desligado. Instale o R em cloud.r-project.org (abre em uma nova guia) e compile de novo. - O Oleafly precisa do Quarto 1.5 ou mais novo. Se o seu for mais antigo, o Oleafly usa a própria cópia, ou pede que você baixe uma em Configurações → Motores → Quarto. Sem nenhuma cópia baixada, um documento em um projeto
_quarto.ymlcompila com o seu Quarto mais antigo. - O código Python roda no ambiente do próprio projeto quando o projeto tem uma pasta
.venv,venvouenvcom o Jupyter instalado, e o Calepin usa uma pasta.venvquando o projeto tem uma. Caso contrário, o código roda no Python listado em Linguagens, em Configurações → Motores → Quarto. - Um documento
pdfoubeamerprecisa de LaTeX. Sem TeX instalado, instale o TinyTeX quando o Oleafly oferecer, mude o documento paraformat: typst, ou acrescentepdf-engine: tectonicao front matter para usar o motor embutido depois que o código for permitido. - O Quarto grava um arquivo de trabalho com o nome do documento ao lado dele:
report.texpara um PDF, oureport.typpara o Typst. Se um arquivo seu já tem esse nome, a compilação para e o nomeia em vez de substituí-lo. Renomeie ou mova o seu arquivo e compile de novo. - Se faltam caracteres coreanos, chineses ou japoneses no PDF, o aviso nomeia uma fonte e dá duas linhas para acrescentar ao front matter:
CJKmainfont:com essa fonte, epdf-engine: tectonic. Acrescente as duas, porque a fonte vem com o motor embutido.pdf-engine: tectonicsó funciona depois que o código é permitido para o projeto. - Um notebook pode rodar por até uma hora. Depois disso, o Oleafly o interrompe e o log mostra a célula que ele alcançou. Encurte ou guarde em cache essa célula e compile de novo.
Escreva o resultado
Seção intitulada “Escreva o resultado”Peça ao assistente que redija uma passagem de resultados usando somente as saídas revisadas. Confira cada número contra a tabela e mantenha o método distinto da interpretação.
Compile o documento e revise a tabela ou a figura completa no PDF, incluindo rótulos e legenda.