Scrierea de lucrări științifice cu asistenți de cvarto și AI

Mai jos este fluxul meu de lucru sugerat pentru utilizarea Quarto pentru a scrie lucrări științifice. În prezent trec la a face cât mai multe proiecte cu Quarto, mai degrabă decât cu Word din câteva motive:

1. Mai ușor de gestionat stilul documentului
2. Mai ușor de gestionat referințe
3. Fluxuri de lucru pe care le-a făcut figuri/tabele de actualizare automată atunci când codul R este re-rulat
4. Integrare AI generativă care poate fi personalizabilă.

Punctul 3 este grozav, nu mai sunt cifre mai tăiate și lipite în documente de cuvinte!

Punctul 4 este cel mare. Îmi dezvolt propriile scripturi „mentor de scriere” pentru modele de limbaj mare. Utilizarea Quarto mă permite să implementez sfaturi de scriere specifice direcției științifice în manuscrisele mele.

Quarto este „ceea ce vezi este ceea ce faci”, ceea ce înseamnă că scrii sintaxă specială pentru formatare. Odată ce ești obișnuit cu asta, aceasta este o modalitate mai ușoară de a gestiona stiluri decât de cuvânt.

Dezavantajul este ca colaboratorii (non-codificați) să editeze fișierele în quarto. Acesta este cel mai mare blocaj pentru utilizarea mea de quarto/marcaj. În prezent, le trimit documente de cuvinte, apoi trebuie să integreze manual feedback -ul. Sau lucrez în Quarto până la etapele finale aproape, acceptând doar comentarii, apoi le fac să editeze manuscrisul final.

De exemplu, am scris cea mai mare parte a acestei lucrări în Markdown, dar a trebuit să merg la editarea cuvintelor spre final, astfel încât să pot primi modificări de la colaboratorul meu. După ce l -ai progresat în Word, este greu să te întorci la Markdown.

Instrucțiunile de mai jos sunt la nivel înalt. Există destul de multe piese de software pe care trebuie să le faceți acest lucru, așa că am legat de tutoriale pentru fiecare de mai jos.

1. Descărcați și instalați un IDE

Descărcați și instalați vscode.

Instrucțiuni online, de exemplu, aici

Folosesc VSCODE datorită integrării sale de asistent AI. Dar puteți utiliza, de asemenea, Positron dacă aveți probleme cu VSCODE sau doriți să utilizați un produs Posit, mai degrabă decât un produs Microsoft.

2. Ia Git și Github

Instalați Git pe computer. Opțional, obțineți un cont GitHub și conectați -vă la acesta. Git are controlul versiunii. Github vă permite să împărtășiți asta online. Dacă colaboratorii dvs. sunt utilizatori GitHub, atunci puteți partaja modificări pe documente în acest fel.

GIT este, de asemenea, esențial dacă utilizați asistenți AI. Uneori, îți completează în mare parte documentele. Așadar, păstrarea back -up -urilor cu Git este esențială.

3. Extensii VSCODE

Instalați aceste extinderi VSCODE (sau echivalenți dacă utilizați Positron, rețineți că multe extensii VSCODE sunt, de asemenea, compatibile cu Positron)

Deschideți vscode și faceți clic pe pictograma „Extensie” a celor patru casete de pe LHS, apoi căutați și instalați extensia Quarto.

Extensii opționale:

4. Pași opționali pentru integrarea AI

Acest pas următor este opțional. Dacă utilizați Quarto sau Markdown este posibil să obțineți modele de limbă mare pentru a ajuta la multe sarcini de scriere a hârtiei (inclusiv scrisul). Aceasta este însă o zonă specializată și am dat doar instrucțiuni tehnice de bază aici. De fapt, obținerea de a funcționa bine este un alt subiect cu totul și ceva ce încă mai dezvolt …

Obțineți o cheie API cu un furnizor LLM (de exemplu, OpenRouter, Openai, antropic). Veți avea nevoie de un cont de dezvoltator pentru a obține o cheie API, mai degrabă decât un cont obișnuit pe care îl puteți avea deja (consultați linkurile din ultima propoziție). Cumpărați câteva credite, astfel încât să puteți utiliza API -ul dvs.

Asigurați -vă că vă salvați cheia API undeva în siguranță! De obicei, le puteți vizualiza doar o dată pe creație. Veți avea nevoie de el pentru atelier.

Obțineți extensia codului ROO pentru vscode/pozitron.

Citiți documentele/Urmăriți tutorialele și aflați cum să utilizați codul ROO

Acum puteți crea un mod personalizat, de exemplu, un „mod de scriere științifică” în codul ROO. În ceea ce privește scrierea, acest lucru este nevoie de clic pe butonul de selecție a modului din partea de jos a panoului Cod Roo, apoi faceți clic pe COG, apoi COG, apoi + buton pentru a face un mod nou. Apoi, trebuie să scrieți o „definiție a rolului” și „instrucțiuni personalizate”. Pentru instrumente, folosesc doar „citiți fișiere”, „editați fișiere” și le desface pe celelalte (vă voi economisi bani și jetoane).

Aceasta este partea grea care are nevoie de multă gândire:

În instrucțiunile personalizate, ar trebui să scrieți instrucțiuni detaliate despre cum să ajutați un autor cu scriere științifică. De exemplu, poate doriți să puneți câteva instrucțiuni foarte puternice despre faptul că nu faceți referințe. De asemenea, s -ar putea să puneți instrucțiuni despre preferințele dvs. particulare de stil de scriere. Lucrez la un șablon, dar încă nu sunt pregătit să -l împărtășesc.

Consultați documentația Codului ROO pentru mai multe sfaturi despre modurile personalizate.

5. folosind quarto

Luați un tutorial și învățați cum să utilizați quarto.

Pentru scrierea hârtiei academice, lucrurile cheie de înțeles din tutorialul Quarto sunt:

• Cum să tricotați ca cuvânt sau PDF (PDF necesită instalații software suplimentare)
• Formatare, titluri, îndrăznețe etc …
• Yaml frontmatter pentru stiluri, care leagă un stil de bibliografie și bibliografie
• Cum se introduce imagini și/sau cod.

Notă despre integrarea AI După ce utilizați codul quarto și roo, puteți pur și simplu să solicitați codului Roo să facă lucruri în documentul dvs. (cum ar fi conturul unui șablon de hârtie), făcând referire la fișierul (de exemplu, @myfile.qmd) în caseta promptă.

Dacă acest lucru funcționează bine pentru dvs. este o altă întrebare. A solicita bine necesită multă gândire și practică. Nu va scrie pur și simplu o hârtie pentru tine. Trebuie să oferiți asistentului AI detaliat, specific, instrucțiuni și mult context.

6. Yaml Front Matter

YAML Controlează modul în care este redat documentul QMD. Iată un exemplu de al meu:

---
title: "The paper's title"
format: docx
editor: visual
bibliography: mybib.bib
csl: myjournal.csl
execute: 
  echo: false
  message: false
  warning: false
---

Acest lucru merge în partea de sus a documentului. Câteva puncte cheie.

format Controlează tipul de document pentru a face acest lucru ca, aici un document Word.

editor Controlează modul în care este vizualizat în vscode. Opțiunile sunt editor: visual şi editor: source. Visual arată mai mult ca un document de cuvânt, sursa arată mai mult ca Markdown. Va trebui să salvați și să redeschideți documentul pentru ca acesta să se schimbe.

bibliography Link -uri către un fișier Bibtex unde sunt stocate referințele dvs.

csl Link -uri către un ghid de stil pentru bibliografie.

Mai multe despre stiluri și referințe de mai jos.

execute controlează modul în care este rulat codul R și dacă apare codul R în document.

7. Redarea ca document

Utilizați tasta scurtă „CMD-SHIFT-K”/’CNTRL-SHFT-K’ (Mac/Windows) pentru a previzualiza documentul. De asemenea, va crea o versiune redată în directorul dvs. curent.

Este util să setați: format: html Când scrieți documentul, veți primi o previzualizare live în VSCODE. Utilizare format: docx Când doriți un document Word.

Merită să înveți, de asemenea, `cmd-shft-p ‘/’ cntrl-shft-p ‘, aceasta aduce acțiuni căutabile pentru toate extensiile din VSCODE. Cel pe care îl doriți este „Quarto: Previzualizare”, care face la fel ca comanda rapidă de mai sus.

Am tendința să am un cod R minim în manuscrisul meu Quarto. Sau deloc deloc (doar referință fișiere .png pentru cifre). Acest lucru continuă să fie rapid. De asemenea, documentul dvs. poate obține nedorit dacă există mult text amestecat cu codul R.

8. Numărul de cuvinte

Există diverse extensii de număr de cuvinte pentru documentele VSCODE QMD și MD.

9. Stiluri de documente

Obținerea unui document Word pentru a urma un anumit stil este un pic fiddly. Trebuie să configurați un document Word de șablon cu stiluri, includeți că ca referință în YAML-ul dvs.

Vezi instrucțiunile aici.

10. Integrarea managerului de referință

Quarto se integrează cu mulți manageri de referință diferiți. Există un ghid bun aici.

Pe scurt, creați un .bib Fișier care are referințele dvs. în el. Aceasta este apoi legată în YAML. Modul manual de a gestiona acest lucru este doar de a crea un .bib Fișier și lipiți intrări Bibtext direct în acesta (disponibile pe majoritatea paginilor jurnalului ca format de citare, precum și Google Scholar).

de exemplu, bibtext pentru r arată astfel:

@Manual{Rlanguage,
    title = {R: A Language and Environment for Statistical Computing},
    author = ,
    organization = {R Foundation for Statistical Computing},
    address = {Vienna, Austria},
    year = {2024},
    url = {https://www.R-project.org/},
  }

Apoi în quarto tastați doar @ Și va apărea o abandonare a tuturor referințelor dvs. @Manual{Rlanguage, Bitul rlanguage este citekey -ul care va apărea în meniul vertical. Aşa @Rlanguage va insera această referință în bibliografie și citarea din acel loc din document.

Puteți eficientiza procesul de colectare și gestionare a referințelor cu un manager de referință.

Fluxul meu de lucru din Zotero este următorul:

• Deschide Zotero pe computerul meu
• Accesați Pagina Web Journal pentru hârtie
• Utilizați pluginul Zotero în browserul meu pentru a apuca citarea și a -l salva într -o bibliotecă
• Accesați documentul meu Quarto din vscode
• tip @ Și apare o scădere a tuturor referințelor din toate bibliotecile de pe Zotero. Alege -l pe cel pe care îl vreau.
• Faceți clic pe OK buton care salvează această referință în localul meu .bib fişier.

Dintr -un anumit motiv (asta nu pare să fie documentat în niciun tutorial de quarto nicăieri!) Va găsi orice referință pe care o am oriunde în Zotero și apoi va salva această intrare Bibtex la localul meu local .bib Fișier, deci acum este accesibil pentru utilizare în documentul meu Quarto. Acest lucru funcționează numai dacă am Zotero deschis și folosesc editor: visual în yaml.

Cu toate acestea, există multe alte opțiuni.

11. Integrare opțională AI pentru gestionarea referinței

Puteți obține asistenți AI pentru a vă ajuta la referință dacă păstrați notele dvs. pe lucrările legate de referințele dvs. De exemplu, vă puteți păstra notele cu privire la referințe în câmpul Bibtex pentru notes. În mod alternativ, puteți crea un alt document de cvarto/marcaj care are un antet pentru fiecare etichetă de citare, împreună cu notele sale într -un mod structurat:

## Rlanguage 

### What it is

The R software for scientific computing. 

### Usage

Citation for the R software. Use this at least once in every paper where i've used R for statistics

## edgar2023continent

### What is it

Key paper that shows Australia is losing its marine biodiversity. 

### Usage

Cite this as evidence that Australia is losing coastal marine biodiversity and as evidence that climate change is causing marine biodiversity loss

Nu contează cum faceți acest lucru, atât timp cât urmați o structură consistentă. Am folosit citekey ca antet principal pentru fiecare intrare de referință. Apoi am introdus secțiuni de marcă despre fiecare hârtie și de ce aș putea să o citez. Apoi, puteți obține codul ROO pentru a ajuta la introducerea referințelor.

Rețineți că dacă utilizați .bib În mod direct, aveți grijă să nu plagiați! Codul Roo ar putea introduce extrase din rezumate/titluri direct în documentul scris, care nu este un no-no pentru publicare.