Customize your research website

Adding project details

workflowr automatically creates many files when the project is first started. As a first step for customizing your site, add the following information:

• Briefly describe your project in analysis/index.Rmd
• Share details about yourself in analysis/about.Rmd
• State a software license in analysis/license.Rmd. See A Quick Guide to Software Licensing for the Scientist-Programmer by Morin et al., 2012 for advice. If you’re ambivalent, the MIT license is a standard choice.

Changing the theme

The theme is defined in the file analysis/_site.yml. The default is cosmo, but the rmarkdown package accepts multiple Bootstrap themes. These are listed in the rmarkdown documentation. Go to bootswatch.com to compare the bootstrap themes. When typing the theme, make sure it is all lowercase (e.g. spacelab, united, etc.).

When experimenting with different themes, you’ll want to build a fast-running file, e.g. likely analysis/index.Rmd, instead of rebuilding the entire site every time. Click the RStudio Knit button or run wflow_build() in the R console to preview each theme:

wflow_build("analysis/index.Rmd")

Once you have chosen a theme, update the website by running the following:

wflow_publish("analysis/_site.yml", "Change the theme", republish = TRUE)

This commits analysis/_site.yml, re-builds every previously published HTML file using the new theme, and commits all the republished HTML pages.

Style with custom CSS

For ultimate control of the style of your website, you can write custom CSS rules to apply to the R Markdown files. For a workflowr project, follow these steps to get started:

1. Create the file analysis/style.css

2. Register the CSS file in analysis/_site.yml:

   output:
     workflowr::wflow_html:
       toc: true
       toc_float: true
       theme: cosmo
       highlight: textmate
       css: style.css

3. Run wflow_build() to preview the changes

4. Once you are satisfied with the appearance of the site, publish the results

   wflow_publish(c("analysis/_site.yml", "analysis/style.css"),
                 message = "Customize website style.",
                 republish = TRUE)

To specifically change the style of the workflowr components of the website, you can write your CSS rules to target the custom workflowr classes. The example CSS rules below demonstrate how to affect every workflowr button using the class btn-workflowr and also how to affect specific workflowr buttons using the more specialized classes.

/* Center workflowr buttons */
.btn-workflowr {
  display: block;
  margin: auto;
}


/* Add red border around workflowr report button */
.btn-workflowr-report {
  border: red 5px solid;
}


/* Add blue border around workflowr past figure version buttons */
.btn-workflowr-fig {
  border: blue 5px solid;
}


/* Add purple border around workflowr session information button */
.btn-workflowr-sessioninfo {
  border: purple 5px solid;
}

Customize the navigation bar

The navigation bar appears on the top of each page. By default it includes links to index.html (Home), about.html (About), and license.html (License). This is all specified in analysis/_site.yml. If you run either wflow_use_github() or wflow_use_gitlab(), a link to your source code on GitHub or GitLab will be added to the navigation bar.

If you have other important pages, you can add them as well. For example, to add the text “The main result” which links to main-result.html, you would add the following:

    - text: "The main result"
      href: main-result.html

You can also create a drop-down menu from the navigation bar. See the rmarkdown documentation for instructions.

Similar to changing the theme above, you will need to re-render each page of the website (the navbar is embedded within each individual HTML file). Thus you could run the same command as above:

wflow_publish("analysis/_site.yml", "Add main result page to navbar",
              republish = TRUE)

Setup SSH keys

Using the https protocol to communicate with GitHub is tedious because it requires entering your GitHub username and password. Using SSH keys for authentication removes the password requirement. Follow these GitHub instructions for creating SSH keys and linking them to your GitHub account. You’ll need to create separate SSH keys and link them each to GitHub for each machine where you clone your Git repository.

After you create your SSH keys and add them to your GitHub account, you’ll need to instruct your local Git repository to use the SSH protocol. For a hypothetical GitHub username of “myname” and GitHub repository of “myproject”, you would change the remote “origin” (the default name by convention) using the function wflow_git_remote():

wflow_git_remote(remote = "origin", user = "myname", repo = "myproject",
              protocol = "ssh", action = "set_url")

Alternatively you could update the remote URL using Git directly in the shell. See this GitHub documentation on changing a remote URL for instructions.

Change the session information function

The default function used to report the session information is sessionInfo(). To change this, you can edit this setting in _workflowr.yml. For example, to instead use devtools::session_info(), add the following line to _workflowr.yml:

sessioninfo: "devtools::session_info()"

If you’d prefer to manually insert a more complex report of the session information, disable the automatic reporting by adding the following to _workflowr.yml:

sessioninfo: ""

Note however that workflowr will still check for the presence of a session information function. Specifically it expects to find either sessionInfo or session_info somewhere in the R Markdown document.