2  Publishing your analysis to the web with GitHub Pages

Learning Objectives

  • How to use Git, GitHub (+Pages), and Quarto to publish an analysis to the web

2.1 Introduction

Sharing your work with others in engaging ways is an important part of the scientific process.

So far in this course, we’ve introduced a small set of powerful tools for doing open science:

  • R and its many packages
  • RStudio
  • Git
  • GitHub
  • Quarto

Quarto, in particular, is amazingly powerful for creating scientific reports but, so far, we haven’t tapped its full potential for sharing our work with others.

In this lesson, we’re going to take our training_{USERNAME} GitHub repository and turn it into a beautiful and easy to read web page using the tools listed above.

Set up

  1. Make sure you are in training_{USERNAME} project

  2. Add a new Quarto file at the top level called index.qmd

    1. Go to the RStudio menu File > New File > Quarto Document…
    2. This will bring up a dialog box. Add the title “GitHub Pages Example”, keep the Default Output Format as “HTML”, and then click “OK”

  3. Save the Quarto file you just created. Use index.qmd as the file name

    1. Be sure to use the exact case (lower case ‘index’) as different operating systems handle case differently and it can interfere with loading your web page later

  4. Press “Render” and observe the rendered output

    1. Notice the new file in the same directory index.html
    2. This is our Quarto file rendered as HTML (a web page)

  5. Commit your changes (for both index.qmd and index.html) with a commit message, pull and then push to GitHub

  6. Open your web browser to the GitHub.com and navigate to the page for your training_{USERNAME} repository

  7. Activate GitHub Pages for the main branch

    1. Go to Settings > Pages (underneath the Code and Automation section)
    2. Keep the “Source” as “Deploy from a branch”
    3. Under “Branch” you’ll see a message that says “GitHub Pages is currently disabled”. To change this, change the branch from “None” to main. Keep the folder as the root and then click “Save”
    4. You should see the message change to “Your GitHub Pages site is currently being built from the main branch”

Note: index.qmd represents the default file for a web site, and is returned whenever you visit the web site but doesn’t specify an explicit file to be returned.

Now, the rendered website version of your repo will show up at a special URL.

GitHub Pages follows a convention like this:

GitHub Pages URL pattern

Note that it changes from github.com to github.io

  • Go to https://{username}.github.io/{repo_name}/ (Note the trailing /)
  • Observe the awesome rendered output

Now that we’ve successfully published a web page from an Quarto document, let’s make a change to our document and follow the steps to publish the change on the web:

Update content in your published page
  • Go back to your index.qmd
  • Delete all the content, except the YAML frontmatter
  • Type “Hello world”
  • Save and render your file
  • Use Git workflow: Stage > Commit > Pull > Push
  • Go back to https://{username}.github.io/{repo_name}/

Next, we will show how you can link different qmds rendered into html so you can easily share different parts of your work.

Exercise

In this exercise, you’ll create a table of contents with the lessons of this course on the main page, and link some of the files we have work on so far.

  • Go back to the RStudio server and to your index.qmd file
  • Create a table of contents with the names of the some of the technical lessons we have or will cover:
## R workshop

- Introduction to Quarto 
- Cleaning and Wrangling data
- Data Visualization
- Spatial Analysis

  • Make sure you have the html versions of your intro-to-quarto.qmd and data-cleaning.qmd files. If you only see the qmd version, you need to “Render” your files first

  • In your index.qmd let’s add the links to the html files we want to show on our webpage. Do you remember the Markdown syntax to create a link?

Markdown syntax to create a link:
  • [Text you want to hyperlink](link)
    • Example: [Data wrangling and cleaning](data-wrangling-cleaning.html)
  • Use Git workflow: Stage > Commit > Pull > Push

Now when you visit your web site, you’ll see the table of contents, and can navigate to the others file you linked.

Quarto web pages are a great way to share work in progress with your colleagues. Here we showed an example with the materials we have created in this course. However, you can use these same steps to share the different files and progress of a project you’ve been working on. To do so simply requires thinking through your presentation so that it highlights the workflow to be reviewed. You can include multiple pages and build a simple web site and make your work accessible to people who aren’t set up to open your project in R. Your site could look something like this: