R Anteckningsböcker för att kommunicera forskning

I det här blogginlägget kommer vi att titta på att kommunicera forskning och presentera dessa resultat med hjälp av R-anteckningsböcker. Vi hoppas att det du får ut av den här handledningen är ett ramverk för dig att rapportera och kommunicera alla typer av forskningsresultat med hjälp av R-anteckningsböcker.

Det finns några stora fördelar med att göra detta, särskilt när det kommer till idén om reproducerbar forskning . Vi kommer att diskutera vad detta betyder och hur man gör det i R-anteckningsböcker.

Innehållsförteckning

• Vad är reproducerbarhet?
• Starta en R-anteckningsbok
• Vi presenterar paketen i R Notebooks
• Lägga till en dynamisk referens i R-anteckningsböcker
• Slutsats

Vad är reproducerbarhet?

Idén med reproducerbarhet är att vem som helst kan granska dina resultat och med tanke på indata och processer som du använde, borde de kunna gå igenom det hela. Det finns några sätt som detta spelar in för våra dataanalysbehov: en miljö som gör saker reproducerbara, se till att människor kan se vad som har bidragit, att enkelt kunna granska en fil och ha en reproducerbar utgivare.

Helst kan någon se exakt hur du kom till rapporten och hur plotten eller tabellen som du använde genererades så att allt är i en fullt reproducerbar miljö.

Nu kanske du undrar hur något som LuckyTemplates eller Excel passar in i detta. Jag skulle säga att det är halvvägs i detta reproducerbara arbetsflöde. När vi tänker på power query i synnerhet är den ganska bra på reproducerbarhet. Tänk på de tillämpade stegen där det är väldigt uppenbart att se processerna som är involverade.

När det kommer till visualiseringar och rapporter är det här det blir lite hårigare. R Notebooks är en del av RStudio. Vi har en kurs på LuckyTemplates-portalen för att få dig igång. Detta är i synnerhet samtal om R Markdown och R Notebooks i synnerhet.

Så om du är bekant med en Jupyter-anteckningsbok är tanken att vi kan varva text och kod för att skapa ett berättande dokument för vår forskning.

Vi kommer att kunna återge dessa resultat i en massa olika utdata. Oavsett om du behöver skapa en PDF eller rendera den till HTML, kan R Notebooks användas för olika filformat.

För att börja, öppna din R-anteckningsbok och gå till Arkiv, Ny fil och sedan R Notebook i RStudio. Vi kommer att arbeta med en äldre datauppsättning i resurserna, med denna riktigt enkla forskningsfråga:

Är priset på en dator överhuvudtaget beroende av om den har en CD-ROM eller inte?

Den här frågan är föråldrad, men vi måste alla börja någonstans. Vi kommer också att lägga skelettet till en forskningsrapport och presentera forskningsresultaten med hjälp av detta grundläggande ramverk.

Vi kommer att se något liknande i RStudio, och det här är vad som kallas en .rmd-fil, som är en R markdown-filtillägg. Detta kan vara lite jobbigt, särskilt om du inte är van vid det, men det finns ett sätt att förhandsgranska den polerade slutprodukten.

Den här delen av anteckningsboken är metadata som kallas YAML-filen.

Efter det avsnittet är dessa baktexter där dina koder kommer att gå. Sedan finns det textdelen av dokumentet med R Markdown . Om du har använt Markdown tidigare är R markdown ganska lika. Vi kan använda saker som asterisker och hash-tecken för att markera och återge våra texter.

Låt oss gå till R Studio och R Notebooks och sedan gå igenom denna analys tillsammans. Klicka på kugghjulet och se till att det står Förhandsgranska i visningsfönstret .

Starta en R-anteckningsbok

Vi klickar på knappen Förhandsgranska och den kommer att be oss att spara den. Återigen, detta är en RMD-fil så vi måste spara den först. På den vänstra rutan ser vi den renderade utmatningen. Om vi ​​nu skulle ändra något här och säga något som Datoranalys och lägga till ett författarnamn som George Mount , måste det stå inom citattecken.

När vi klickar på Spara uppdateras den automatiskt till detta.

Så låt oss leka med det här. Det finns redan ett par platshållare här, vilket är bra. Det första vi ska göra är att skriva "Påverkar en CD-ROM försäljningspriset?" När vi sparar detta blir det Header1. Men om vi ska förvandla detta till två hash-märken, kommer det att förvandlas till Header2 och det blir mindre.

Nästa steg är att göra en introduktion där vi kan ange varför det här är viktigt. Vi kan till exempel säga att CD-ROM är det näst bästa eller något liknande. Om du arbetar med konsumentrapporter eller arbetar på en marknadsavdelning, försöker du få en känsla av vilka funktioner som verkligen är viktiga eller vad konsumenterna letar efter.

Vi ringer till R-paket och sätter igång. En trevlig sak som jag älskar här är att vi faktiskt kan använda HTML i R Notebook. Om vi ​​till exempel vill lämna en kommentar till oss själva kan vi göra något sånt här.

När vi sparar detta visas det inte alls. Så vi lämnar bara detta som en kommentar till oss själva i texten. Detta är något som jag önskar att vi kunde göra på platser som MS Word.

Vi presenterar paketen i R Notebooks

Nästa steg är att använda denna kodplot här och lägga till ett par inställningar. Vi kan använda Python och SQL, men vi använder R för det här exemplet.

Vi kommer att läsa alla paket som vi behöver. Om du inte har dessa på din dator kan du behöva installera dem.

Återigen, detta är inte en fullständig rapport. Vi går igenom ett skelett för att visa dig ett par saker att veta om R Markdown.

Så nu ska vi presentera var vi får vår data och vad som gör den viktig. I det här fallet kan vi säga att vår källa är Journal of Applied Econometrics. När vi gör den här asteriskgrejen kommer den att förvandlas till kursiv stil.

Sedan läser vi en fil i Excel och använder R för att ta in den. Som du kan se ser data redan ganska bra ut, vilket är en annan cool sak med R Notebooks.

Beroende på utdataformatet kan detta till och med dyka upp. Om du använder HTML kan din användare faktiskt bläddra igenom informationen och göra lite grundläggande interaktion. Det är bra att vi verkligen kan göra dessa i livedokument.

Lägga till en dynamisk referens i R-anteckningsböcker

Låt oss nu säga att vi vill inkludera en dynamisk referens i datatexten. Vi vill att det här ska uppdateras regelbundet eftersom det kanske inte är samma sak varje gång vi tittar på rapporten, eller hur? Så vi gör en dynamisk referens här i rad, direkt i texten.

Det finns ett fuskblad och referensguide för alla dessa koder. Gå till Hjälp och välj den för R Markdown så att du kan slå upp alla olika inställningar. Det är nog inte värt att försöka memorera dem eftersom det finns många och du kan bara använda detta istället.

Vi infogar R-biten igen och inkluderar FALSE , nrows och ncols .

När detta har körts och körts kan vi till och med gå till R-miljön för att se om det har förvandlats till objekt.

En annan sak som är trevlig är att om du bara kastar runt idéer och vill veta hur det faktiskt kommer att se ut kan du bara använda konsolen nere i botten. Vi kan köra det på konsolen och se hur utgången ser ut.

Vi går tillbaka till vårt visningsfönster. Nu visas inte det här avsnittet i rapporten alls. Detta är trevligt om du vill använda något objekt, men inte vill visa någon av koden.

Vi använder dessa baktexter på nrows och ncols för att hålla saker dynamiska. Om du har en PDF-rapport och du behöver ändra dessa siffror automatiskt, istället för att hårdkoda dem vecka efter vecka, kan du använda dessa inline-referenser.

Vi håller på att utforska informationen igen och kontrollera datorernas pris.

När vi kör den här koden kan vi se den beskrivande statistiken som alla är snyggt formaterade. Beroende på storleken på datan är den ganska lyhörd och reaktiv mot storleken på filen.

Slutsats

För den här handledningen har vi diskuterat vikten av att utveckla reproducerbar forskning och effektivisera processen för att kommunicera forskningsresultat genom att använda R Notebooks. På så sätt kan vi snabbt och enkelt reproducera de ursprungliga resultaten och spåra tillbaka för att avgöra hur de härleddes. 

Se upp för fortsättningen av denna handledning i del 2 av den här serien.

George Mount