Last updated: 2020-02-25

Checks: 2 0

Knit directory: RcppComputingClub/

This reproducible R Markdown analysis was created with workflowr (version 1.6.0). The Checks tab describes the reproducibility checks that were applied when the results were created. The Past versions tab lists the development history.

R Markdown file: up-to-date

Great! Since the R Markdown file has been committed to the Git repository, you know the exact version of the code that produced these results.

Repository version: 37f27b4

Great! You are using Git for version control. Tracking code development and connecting the code version to the results is critical for reproducibility. The version displayed above was the version of the Git repository at the time these results were generated.

Note that you need to be careful to ensure that all relevant files for the analysis have been committed to Git prior to generating the results (you can use wflow_publish or wflow_git_commit). workflowr only checks the R Markdown file, but you know if there are other scripts or data files that it depends on. Below is the status of the Git repository when the results were generated: 


working directory clean

Note that any generated files, e.g. HTML, png, CSS, etc., are not included in this status report because it is ok for generated content to have uncommitted changes.

These are the previous versions of the R Markdown and HTML files. If you’ve configured a remote Git repository (see ?wflow_git_remote), click on the hyperlinks in the table below to view them.

File Version Author Date Message
Rmd 37f27b4 scristia 2020-02-25 wflow_publish(files = “index.Rmd”)
html 974136c scristia 2020-02-25 Build site.
html 4463b2b scristia 2020-02-25 Build site.
html 8368057 scristia 2020-02-25 Build site.
Rmd 6946ee8 scristia 2020-02-25 wflow_publish(files = “index.Rmd”)
html 35c100a scristia 2020-02-25 Build site.
Rmd e98074c scristia 2020-02-25 working on index
Rmd 30b5e36 scristia 2020-02-24 wflow_git_commit(all = TRUE)
Rmd a8f70df scristia 2020-02-24 Start workflowr project.

Avoiding R bottlenecks with Rcpp

I will introduce the Rcpp package for streamlining R code with C++ functions to avoid some common computational bottlenecks when writing R functions in a manner that’s easy to use with minimal C++ knowledge. During the presentation, I will provide an example of developing a package with compiled code and demonstrate the “workflowr” package for organizing your projects into a version controlled website for documenting your results.

This document is broken into three main sections:

  1. Brief introduction to Rcpp
  2. Building a package
  3. Case study: Skew Normal Mixture distributions

Using workflowr

This document was created using workflowr. WorkflowR is an R package that allows for an effective and reproducible way to share organize your projects and share your results with collaborators and advisors. The benefit of workflowr is that it allows you to build an organized project template with analyses in Rmarkdown, use git to version control and push to github or gitlab, and publish your results to a website with only a handful of function calls within R.

The main functions you need are:

  1. wflow_start() – Start a new project
  2. wflow_build() – Render Rmarkdown and display html
  3. wflow_status() – show status of project/files needed to be committed
  4. wflow_publish() – deploy website, commit to github/gitlab
  5. wflow_git_push() – push changes

Other useful functions are:

When deploying your website to the internet, note that github pages doesn’t allow for private sites. If privacy is a large concern in your research, consider using gitlab instead.

Learn more here: https://jdblischak.github.io/workflowr/