R Notesbøger til formidling af forskning

I dette blogindlæg vil vi se på at formidle forskning og præsentere disse resultater ved hjælp af R-notesbøger. Vi håber, at det, du får ud af denne tutorial, er en ramme, hvor du kan rapportere og kommunikere enhver form for forskningsresultater ved hjælp af R-notesbøger.

Der er nogle store fordele ved at gøre dette, især når det kommer til ideen om reproducerbar forskning . Vi vil diskutere, hvad det betyder, og hvordan man gør det i R-notesbøger.

Indholdsfortegnelse

• Hvad er reproducerbarhed?
• Start af en R notesbog
• Introduktion til pakkerne i R-notebooks
• Tilføjelse af en dynamisk reference i R-notebooks
• Konklusion

Hvad er reproducerbarhed?

Ideen med reproducerbarhed er, at enhver kan auditere dine resultater, og givet de input og processer, du brugte, burde de være i stand til at gennemgå det hele. Der er et par måder, hvorpå dette kommer i spil for vores dataanalysebehov: et miljø, der gør tingene reproducerbare, sørger for, at folk kan se, hvad der blev bidraget, nemt at kunne revidere en fil og have en reproducerbar udgiver.

Ideelt set kan nogen se præcis, hvordan du kom til rapporten, og hvordan plottet eller tabellen, du brugte, blev genereret, så alt er i et fuldt reproducerbart miljø.

Nu undrer du dig måske over, hvordan noget som LuckyTemplates eller Excel passer ind i dette. Jeg vil sige, at det er midtvejs i denne reproducerbare arbejdsgang. Når vi tænker på power query i særdeleshed, er den ret god til reproducerbarhed. Tænk på de anvendte trin , hvor det er meget tydeligt at se de involverede processer.

Når det kommer til visualiseringer og rapporter, er det her, tingene bliver lidt mere behårede. R Notebooks er en del af RStudio. Vi har et kursus på LuckyTemplates-portalen for at få dig i gang. Dette er især taler om R Markdown og R Notebooks i særdeleshed.

Så hvis du er bekendt med en Jupyter-notesbog , er ideen, at vi er i stand til at blande tekst og kode for at skabe et historiefortællingsdokument til vores forskning.

Vi vil være i stand til at gengive disse resultater i en masse forskellige output. Uanset om du skal oprette en PDF eller gengive den til HTML, kan R Notebooks bruges til forskellige filformater.

For at starte skal du åbne din R notesbog og gå til Fil, Ny fil og derefter R Notebook i RStudio. Vi vil arbejde med et ældre datasæt i ressourcerne med dette virkelig simple forskningsspørgsmål:

Er prisen på en computer overhovedet afhængig af, om den har en cd-rom eller ej?

Dette spørgsmål er forældet, men vi skal alle starte et sted. Vi vil også sætte skelettet til en forskningsrapport og præsentere forskningsresultaterne ved hjælp af denne grundlæggende ramme.

Vi vil se noget som dette i RStudio, og det er det, der kaldes en .rmd-fil, som er en R markdown-filtypenavn. Dette kan være lidt skurrende, især hvis du ikke er vant til det, men der er en måde at få vist det polerede slutprodukt på.

Denne del af notesbogen er metadataene kaldet YAML-filen.

Efter det afsnit er disse bagsidetekster, hvor dine koder vil gå. Så er der tekstdelen af ​​dokumentet ved hjælp af R Markdown . Hvis du har brugt Markdown før, er R markdown ret ens. Vi kan bruge ting som stjerner og hash-tegn til at markere og gengive vores tekster.

Lad os gå til R Studio og R Notebooks, og derefter gennemgå denne analyse sammen. Klik på tandhjulet, og sørg for, at der står Forhåndsvisning i fremviseruden .

Start af en R notesbog

Vi klikker på Preview-knappen, og den vil bede os om at gemme den. Igen, dette er en RMD-fil, så vi bliver nødt til at gemme den først. I venstre rude ser vi det gengivede output. Hvis vi nu skulle ændre noget her og sige noget som Computeranalyse og tilføje et forfatternavn som George Mount , bliver det nødt til at stå i anførselstegn.

Når vi klikker på Gem , vil den automatisk opdatere til dette.

Så lad os lege med det her. Der er allerede et par pladsholdere her, hvilket er fint. Den første ting, vi skal gøre, er at skrive "Påvirker en cd-rom salgsprisen?" Når vi gemmer dette, bliver det Header1. Men hvis vi skal gøre dette til to hash-mærker, bliver det til Header2, og det bliver mindre.

Det næste trin er at lave en introduktion , hvor vi kan indtaste, hvorfor disse ting er vigtige. For eksempel kan vi sige, at CD-ROM er den næstbedste ting eller sådan noget. Hvis du arbejder på forbrugerrapporter eller arbejder i en marketingafdeling, forsøger du at få en fornemmelse af, hvilke funktioner der virkelig er vigtige, eller hvad forbrugerne leder efter.

Vi ringer til R-pakker og går i gang. Den ene gode ting, som jeg elsker her, er, at vi faktisk kan bruge HTML i R Notebook. Hvis vi for eksempel vil efterlade en kommentar til os selv, kan vi gøre sådan noget.

Når vi gemmer dette, dukker det slet ikke op. Så vi overlader bare dette som en kommentar til os selv i teksten. Dette er noget, jeg ville ønske, vi kunne gøre på steder som MS Word.

Introduktion til pakkerne i R-notebooks

Det næste trin er at bruge dette kodeplot her og tilføje et par indstillinger. Vi kan bruge Python og SQL, men vi bruger R til dette eksempel.

Vi læser alle de pakker, vi har brug for. Hvis du ikke har disse på din computer, skal du muligvis installere dem.

Igen, dette er ikke en fuldstændig rapport. Vi går gennem et skelet for at vise dig et par ting, du skal vide om R Markdown.

Så nu skal vi introducere, hvor vi får vores data, og hvad der gør det vigtigt. I dette tilfælde kan vi sige, at vores kilde er Journal of Applied Econometrics. Når vi gør denne stjerneting, vil den gøre den til kursiv.

Så læser vi en fil i Excel og bruger R til at bringe den ind. Som du kan se, ser dataene allerede ret godt ud, hvilket er en anden cool ting ved R Notebooks.

Afhængigt af outputformatet kan dette endda dukke op. Hvis du bruger HTML, kan din bruger faktisk bladre gennem dataene og foretage nogle grundlæggende interaktioner. Det er fantastisk, at vi virkelig er i stand til at gøre disse i levende dokumenter.

Tilføjelse af en dynamisk reference i R-notebooks

Lad os nu sige, at vi ønsker at inkludere en dynamisk reference i datateksten. Vi ønsker, at dette skal opdateres regelmæssigt, fordi det måske ikke er det samme, hver gang vi er på rapporten, ikke? Så vi laver en dynamisk reference her på linje, lige i teksten.

Der er et snydeark og referencevejledning til alle disse koder. Gå til Hjælp og vælg den til R Markdown, så du kan slå alle de forskellige indstillinger op. Det er nok ikke værd at prøve at lære dem udenad, for der er mange, og du kan bare bruge dette i stedet for.

Vi indsætter R-delen igen og inkluderer FALSE , nrows og ncols .

Når dette er blevet kørt og udført, kunne vi endda gå til R-miljøet for at se, om det er blevet omdannet til objekter.

En anden ting, der er rart, er, at hvis du bare smider rundt med ideer, og du gerne vil vide, hvordan det rent faktisk kommer til at se ud, kan du bare bruge konsollen nede i bunden. Vi kan køre det på konsollen og se, hvordan outputtet ser ud.

Vi går tilbage til vores fremviserrude. Nu vises dette afsnit her slet ikke i rapporten. Dette er rart, hvis du vil bruge et eller andet objekt, men ikke ønsker at vise noget af koden.

Vi bruger disse bagsidetekster på nrows og ncols for at holde tingene dynamiske. Hvis du har en PDF-rapport, og du automatisk skal ændre disse tal, i stedet for at hårdkode dem uge efter uge, kan du bruge disse inline-referencer.

Vi er i gang med at udforske dataene igen og tjekke computernes pris.

Når vi har kørt denne kode, kan vi se den beskrivende statistik, som alle er pænt formateret. Afhængigt af størrelsen på dataene er den ret lydhør og reaktiv i forhold til størrelsen af ​​filen.

Konklusion

Til denne øvelse har vi diskuteret vigtigheden af ​​at udvikle reproducerbar forskning og strømline processen med at formidle forskningsresultater ved at bruge R Notebooks. På denne måde kan vi hurtigt og nemt reproducere de originale resultater og spore tilbage for at bestemme, hvordan de blev afledt. 

Hold øje med fortsættelsen af ​​denne tutorial i del 2 af denne serie.

George Mount