class: center, middle, inverse, title-slide .title[ # Web-based Distribution of Research Using GitHub ] .subtitle[ ## Using GitHub for Open-Source Analytics, Reporting, and Dissemination of Research ] .author[ ### Allie Cooperman ] .institute[ ### University of Minnesota ] .date[ ### April 20th, 2022<br>NCME 2022 Annual Meeting<br>Demonstration Session <a href="https://github.com/alliecooperman" target="_blank" class="github-corner" aria-label="View source on Github"><svg viewBox="0 0 250 250" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path class="octo-arm" d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;"></path><path class="octo-body" d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor"></path></svg></a> ] --- layout: true <!--this adds the footer to all slides, depends on footer class in css--> <div class="footer" style="left: 5%;"><img src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" style = "max-width: 40%; opacity: 0.5;"></img></div> <div class="footer" style="left: 7.5%;"><img src="https://mirrors.creativecommons.org/presskit/icons/by.svg" style = "max-width: 40%; opacity: 0.5;"></img></div> <div class="footer" style="left: 40%;"><a class="footer" href="https://centerforassessment.github.io/Internship_2021">Research Distribution using GitHub</a></div> --- class: inverse, center, middle # Disseminating Results through <br/> GitHub Pages --- <style type="text/css"> h3 { border-bottom: none; } </style> # Improving Dissemination -- ### Data analysts, researchers, and practitioners are often looking for ways to clearly disseminate their findings to a broad audience. -- ### The open science push is fostering new ways to share code, data, and results that promote replication and reproducibility. -- ### [GitHub](https://github.com/) is an outstanding platform for distributing one's work, combining steps of the research project into one repository (i.e., "repo"). -- ### How can we further improve the organization and presentation of a GitHub repo to more clearly disseminate one's work? --- # GitHub Pages -- ### [GitHub Pages](https://pages.github.com/) allows users to turn their GitHub repo into a shareable, easy-to-read website. -- ### GitHub Pages is advantageous for dissemination because: -- - Source code is easily available, facilitating reproducibility. -- - Intensive webpage skills (e.g., HTML, JavaScript) are unnecessary, increasing accessibility to new users. -- - GitHub is structured to foster collaboration. --- # GitHub Pages -- ### Any public repo can be hosted as a GitHub page with a quick change of the repo settings. -- ### After cloning the repo to a local machine, users can build webpages using R and Markdown. -- ### Numerous (customizable) themes are available, including: -- - [Supported themes from GitHub Pages](https://pages.github.com/themes/); -- - Using the [pkgdown](https://pkgdown.r-lib.org/) R package (Wickham et al., 2022); -- - Themes created by other GitHub users. --- ## Combining Pages with Open-Source R Packages -- ### Open-source R packages available on CRAN and GitHub allow you to more easily customize your website. -- ### The "packagePages" package from Center for Assessment was constructed by modifying "pkgdown," and builds websites through R/RStudio. -- ### The template "centerProjectTemplate" goes with "packagePages" to personalize the website design (e.g., organization colors and logos, navigation bar, headers and footers). --- ## What Can You Include in Your Website? -- ### Because GitHub Pages uses Git, R, and Markdown, numerous file types are available for your website: -- - R Source code -- - PDF or HTML presentations -- - Dynamic HTML files -- ### In the context of a research project, users might push: -- - Research findings with reproducible code -- - Help files for R or Python functions -- - Vignettes demonstrating different analytic methods -- - Tutorials for running an analysis with a particular data set --- ## Graduate Student Internship Website -- ### Completed a graduate internship with the Center for Assessment in Summer 2021. -- ### Addressed methodological challenges to measuring the academic impact of COVID-19, particularly when making cross-sectional comparisons. -- ### Internship work included: -- - Comparing the efficacy of multiple imputation methods for missing scale scores and student growth percentiles; -- - Exploring propensity score weighting to account for school enrollment changes; and -- - Building R Markdown scripts for automated report generation. --- ## Graduate Student Internship Website #### Created a [GitHub-hosted website](https://centerforassessment.github.io/Internship_2021/) to showcase this work. -- <img src="Web_Based_Distribution_of_Research_Using_GitHub_files/figure-html/internship_homepage-1.png" width="75%" style="display: block; margin: auto;" /> --- ## Graduate Student Internship Website -- <img src="Web_Based_Distribution_of_Research_Using_GitHub_files/figure-html/landing_page_for_propensity_score-1.png" width="75%" style="display: block; margin: auto;" /> --- ## Graduate Student Internship Website -- ### The internship website was created as a public repo, and then cloned to the local machine through an RStudio project. -- ### The "packagePages" and "centerProjectTemplate" packages allowed website customization in line with the Center for Assessment. -- ### Webpages were built through .md (Markdown) and .rmd (R Markdown) files. -- ### Source code was included wherever possible to facilitate reproducibility. --- ## Graduate Student Internship Website -- #### Using R Markdown, we wrote a series of vignettes to present analyses throughout the internship. -- <img src="Web_Based_Distribution_of_Research_Using_GitHub_files/figure-html/vignette_example-1.png" width="70%" style="display: block; margin: auto;" /> --- ## Graduate Student Internship Website -- #### Website source code is available in the repo, but we also included Markdown files with code to recreate the vignette analyses. -- <img src="Web_Based_Distribution_of_Research_Using_GitHub_files/figure-html/landing_page-1.png" width="75%" style="display: block; margin: auto;" /> --- ## Graduate Student Internship Website -- #### PDF slide decks were linked to the website for three organization-wide presentations. -- <img src="Web_Based_Distribution_of_Research_Using_GitHub_files/figure-html/landing_page_internship-1.png" width="60%" style="display: block; margin: auto;" /> --- ## Graduate Student Internship Website -- #### Websites also allow you to include news and updates (e.g., release notes). -- <img src="Web_Based_Distribution_of_Research_Using_GitHub_files/figure-html/page_for_internship_updates-1.png" width="75%" style="display: block; margin: auto;" /> --- # Resources and References -- #### [Internship website example](https://centerforassessment.github.io/Internship_2021/index.html) -- #### [Center for Assessment on GitHub](https://github.com/CenterForAssessment) -- #### [Getting Started with GitHub](https://docs.github.com/en/get-started) -- #### [GitHub Pages Documentation](https://docs.github.com/en/pages) -- #### [pkgdown](https://pkgdown.r-lib.org/authors.html) by Wickham, Hesselberth, & Salmon (2022) -- ## Any questions? coope782 at umn dot edu