RRR – Structuring your project

Author

Søren O’Neill

Published

January 11, 2024

1 Projekt eksempel

  • Download dette RRR projekt eksempel
  • Unzip file i en ny folder et egnet sted
  • I RStudio, lav et nyt R projekt og vælg den folder som existing directory
    • Klik File / New project
    • I dialogen vælg Existing directory
    • Brug browse til at vælge den relevant folder

Disse øvelser løses bedst parvist.

Indtil videre, undlad at ændre filerne og der er igen grund til at bruge meget tid på detaljerne i koden – prøv i stedet at forstå koden og hvordan de forskellige filer hænger sammen, som et struktureret projekt.

  • Hvad handler projektet om?
  • Hvad formål tjener de enkelte filer?
  • Hvordan er filerne relateret til hinanden?

Prøv at:

  • Render et manuskript som html eller word eller pdf

Kig i YAML i main qmd dokumentet

Data for deltager med ID=7 er fejlbehæftet (apparatur fejl).

Hvordan løste kode forfatteren det problem?

Det vil være god Reproducible Research praksis at løse problemer som del af data cleaning og wrangling, fremfor at redigere i rå data.

Kode forfatteren har ikke nær-læst Instructions for Authors til det tidsskrift der skal indsendes til, og har placeret figuren umiddelbart efter første reference.

Faktisk skal:

  • Tabeller placeres i teksten nær første reference
  • Figurer skal placeres i en særskilt sektion ‘Figures’ (umiddelbart før References) og en placeholder <<FIGURE X ABOUT HERE>> skal indsættes i teksten nær første reference.

Hvordan ville du ændre koden.

Kode blokken ‘figure_distribution_by_probe_and session’ i ‘main_v1.qmd’ kan forblive hvor den er og kode blokke ‘show_fig’ kan flyttes længere ned i manuskriptet under en ny overskrift # Figures, umiddelbart før # References sektionen.

Markeringen <<FIGURE X ABOUT HERE>> bør skrives som <<FIGURE @fig-distribution-by-probe-and-session ABOUT HERE>> på en separat linje efter første reference til figuren (“We presented a boxplot…”). Det bliver så konverteret til <<FIGURE 1 ABOUT HERE>>.

Tidsskriftets editorer har beklaget sig over at figuren ikke lever op til tidsskriftets krav.

De vil have filen uploadet som:

  • tiff format
  • 2 tommer (inches) i bredde
  • 1.5 tommer (inches) i højde
  • i 600 dpi resolution

Hvordan vil du fikse det problem og hvor vil du finde output’et?

Hvordan ville du produce en ekstra fil af det samme plot til en poster – denne gang i 6 tommer gange 6 tommer?

Figuren defineres i kode blokken ‘figure_distribution_by_probe_and session’.

Du vil finde alle relevant parametre defineret i funktionen ggsave.

Bero ikke på output’et i RStudios viewer når du skal inspicere figuren gemt i filen – i stedet inspicér den i folderen ‘plots’.

Hvis du vi lgemme en ekstra fil af plottet i en anden størrelse, så kunne du måske bare køre ggsave kommandoen to gange med forskellige parametre?

Du er blevet bedt om at tilføje en reference til publikationen “Swearing as a Response to Pain: Assessing Hypoalgesic Effects of Novel “Swear” Words” af Richard Stephens og Olly Robertson (Frontiers in Psychology).

Hvordan kunne du gøre det? Kig i main_v1.qmd og i reference listen for at få inspiration.

På hjemmesiden Fronties in Psychology finder du et link i højre side ‘Export citation’, som giver dig mulighed for at downloade referencen som BibTeX.

Kig engang i den fil når den er downloadet og sammenlign den med indholdet i references.bib

Copy/paste…

Hver reference er definet med et unikt id i BibTeX definitionen .. kan du se hvor den er definet og hvordan den bruges i reference i quarto dokumentet?

Prøv at give den nye reference et andet id og brug det samme i main_v1.qmd filen til at citere artiklen af Stephens og Robertson.

ØV! Efter alle dine tilpasninger har editors alligevel afvist dit manuskript. Tidsskriftet var vitterligt en ‘Pain’.

Så nu skal du omformattere manuskriptet til et andet tidsskrift og du får derfor brug for en anden reference og bibliografi stil.

Som antydet herover, var manuskriftet tilpasset tidskrift ‘Pain’.

  • Find ud af hvor dit aktuelle reference og bibliografi stil defineres og hvilke filer der er involveret.
  • Vælg et andet tidsskrift – bare en eller anden du kender.
  • Go på internettet og find en ny stil definition for det tidsskrift – “Google is your friend” og det er Zotero også!
  • Fix din reference/bibliografi stil.
  • Reference/bibliografi stilen defineres i YAML i ‘main_v1.qmd’ file – specifikt: csl: pain.csl (linjen bibliography: references.bib definerer BibTeX filen hvor referencerne er gemt, men ikke stilen)
  • Du finder en overflødighedshorn af Citation Style Language (.csl) filer du kan downloade på the ‘Zotero style repository’ – søg og du skal finde – download .csl filen til din projekt folder.
  • Rediger din YAML csl definition så det passer til din nye csl fil og re-render dit manuskript.

Din primære medforfatter på artiklen, Dr. Jekyll har revideret første version af manuskriptet for nogen tid siden. Som et ondt geni bruger Dr. Jekyll selvfølgeligt også R og han har droppet den reviderede qmd file til dig her.

Download Dr. Jekylls reviderede version og sammenlign med din egen. Til det formål kan du gøre brug af diff’ing af filer … kig på noterne her på r4phd om RRR – Collaboration (with R users).

Vær kritisk med hvad du accepterer og hvad du afviser – Dr. Jekylls revision er baseret på en ældre version af dit manuskript.

Du kan bruge denne online diff app … eller du kan vælge at installere er program som f.eks Meld på din egen computer.

Det nye tidsskrift du indsender til kræver at alle overskrifter niveau 1 skal være bold og i en smert farve som du selv vælger.

De insisterer også på at du indsender manuskriptet som en Microsoft Word fil.

Først gør følgende

  1. I YAML sektionen i main_v1.qmd ret format: html til format: docx
  2. Render dokumentet så der geereres en MS Word docx fil som output
  3. Omdøb den fil fra main_v1.docx til my_word_template.docx

Ret nu den samme YAML linje fra format: docx til dette:

format: 
  docx:
    reference-doc: my_word_template.docx

Bemærk teksten skal stå præcist sådan her – linjeskift og mellemrum er vigtige!

Gør nu følgende:

  1. Render dit qmd script igen for at generere en ny main_v1.docx fil
  2. Inspicér den fil (åben den i Word eller LibreOffice) – læg specielt mærke til typografi stilen af niveau 1 overskrifter som Background.
  3. Luk main_v1.docx igen og åben open my_word_template.docx istedet for
  4. Check hvilekn stil der er gældende for Background (sikkert ‘Heading 1’ eller lignende) og redigér den typografi stil i stil editoren. Der er ikke nok bare at ændre overskriften Background – du skal ændre den stil som er associeret med typografien.
  5. Gem my_word_template.docx efter du har lavet ændringerne
  6. Render nu en ny version af main_v1.qmd og se om stil ændringerne har haft effekt.

Nu kan du leje lidt med de andre stil definitioner i dokumentet, f.eks de andre overskrifts niveauer, brødteksten, figur teksten, etc.

Husk at du skal lave ændringerne i typografi stil i my_word_template.docx med stil editoren (og gemme) før du gen-render qmd filen.

Med tanke for at figurer, tabeller, summary statistics mm bruges i ‘main_v1.qmd’, men også er gemt som separate filer, kan du genbrug dem i andre sammenhænge, f.eks en præsentation.

Kig på static presentation qmd og html filerne – du skal også vide, at sådanne filer kan eksporteres til pdf, LibreOffice Impress og Microsoft Power Point filer.

Filen dynamic presentation er ikke færdig endnu, men prøv at google dynamic r presentations.