Last updated: 2019-10-27
Checks: 7 0
Knit directory: smash-paper/analysis/
This reproducible R Markdown analysis was created with workflowr (version 1.4.0). The Checks tab describes the reproducibility checks that were applied when the results were created. The Past versions tab lists the development history.
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.
Great job! The global environment was empty. Objects defined in the global environment can affect the analysis in your R Markdown file in unknown ways. For reproduciblity it’s best to always run the code in an empty environment.
The command set.seed(1)
was run prior to running the code in the R Markdown file. Setting a seed ensures that any results that rely on randomness, e.g. subsampling or permutations, are reproducible.
Great job! Recording the operating system, R version, and package versions is critical for reproducibility.
Nice! There were no cached chunks for this analysis, so you can be confident that you successfully produced the results during this run.
Great job! Using relative paths to the files within your workflowr project makes it easier to run your code on other machines.
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:
Ignored files:
Ignored: .Rproj.user/C795A467/ctx/
Ignored: .Rproj.user/C795A467/explorer-cache/
Ignored: .Rproj.user/C795A467/presentation/
Ignored: .Rproj.user/C795A467/profiles-cache/
Ignored: .Rproj.user/C795A467/sources/per/
Ignored: .Rproj.user/C795A467/viewer-cache/
Untracked files:
Untracked: .Rproj.user/shared/notebooks/ABDC647A-motorcycle/
Unstaged changes:
Modified: .Rproj.user/C795A467/sources/prop/7A16E638
Modified: .Rproj.user/C795A467/sources/s-662254EE/6240C782
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 |
---|---|---|---|---|
html | f0221c5 | Zhengrong Xing | 2019-10-28 | address some reviewer comments |
html | 99d1f34 | Peter Carbonetto | 2018-12-07 | Re-built all the outdated workflowr webpages. |
Rmd | a09d13e | Peter Carbonetto | 2018-11-09 | Adjusted setup steps in a few of the R Markdown files. |
Rmd | f9f193c | Peter Carbonetto | 2018-11-07 | Revised setup instructions for a couple .Rmd files. |
html | 85368eb | Peter Carbonetto | 2018-11-06 | A few final adjustments to the motorcycle example. |
Rmd | 3b7071b | Peter Carbonetto | 2018-11-06 | wflow_publish(“motorcycle.Rmd”) |
html | 3ce045f | Peter Carbonetto | 2018-11-06 | Added explanatory text to motorcycle example. |
Rmd | 4a73ed9 | Peter Carbonetto | 2018-11-06 | wflow_publish(“motorcycle.Rmd”) |
html | d51e8f8 | Peter Carbonetto | 2018-11-06 | Adjusted the plots in the motorcycle example. |
Rmd | fd51be8 | Peter Carbonetto | 2018-11-06 | wflow_publish(“motorcycle.Rmd”) |
html | fdc9c33 | Peter Carbonetto | 2018-11-06 | Build site. |
Rmd | 1ab1447 | Peter Carbonetto | 2018-11-06 | wflow_publish(“motorcycle.Rmd”) |
html | 7d7ce92 | Peter Carbonetto | 2018-11-06 | Added setup instructions to motorcycle example. |
Rmd | f0059b3 | Peter Carbonetto | 2018-11-06 | wflow_publish(“motorcycle.Rmd”) |
Rmd | 507a261 | Peter Carbonetto | 2018-11-06 | Having trouble re-building spikesdemo.html. |
html | f6a9477 | Peter Carbonetto | 2018-10-10 | Completed revisions of motorcycle example. |
Rmd | 7f2ef79 | Peter Carbonetto | 2018-10-10 | wflow_publish(“motorcycle.Rmd”) |
Rmd | 3b3d373 | Peter Carbonetto | 2018-10-09 | Some more improvements to the motorcycle example. |
Rmd | 757462c | Peter Carbonetto | 2018-10-09 | Working on motorcycle .Rmd example. |
This is an illustration of “smoothing via adaptive shrinkage” (SMASH) applied to the Motorcycle Accident data. This implements the “illustrative application” presented in Sec. 5.1 of the manuscript.
To run this example on your own computer, please follow these setup instructions. These instructions assume you already have R and/or RStudio installed on your computer.
Download or clone the git repository on your computer.
Launch R, and change the working directory to be the “analysis” folder inside your local copy of the git repository.
Install the devtools, wavethresh and EbayesThresh packages used here and in the code below:
install.packages(c("devtools","wavethresh","EbayesThresh"))
Finally, install the smashr package from GitHub:
devtools::install_github("stephenslab/smashr")
See the “Session Info” at the bottom for the versions of the software and R packages that were used to generate the results shown below.
Load the MASS, lattice wavethresh, EbayesThresh and smashr packages. The MASS package is loaded only for the Motorcycle Accident data. Some additional functions are defined in functions.motorcycle.R
.
library(MASS)
library(lattice)
library(smashr)
library(wavethresh)
library(EbayesThresh)
source("../code/motorcycle.functions.R")
Note that the MASS and lattice packages are included in most standard R installations, so you probably don’t need to install these packages separately.
Load the motorcycle data from the MASS package, and order the data points by time.
data(mcycle)
x.ini.mc <- sort(mcycle$times)
y.ini.mc <- mcycle$accel[order(mcycle$times)]
Apply SMASH to the Motorcycle Accident data set.
res.mc <- smash.wrapper(x.ini.mc,y.ini.mc)
Create a plot showing the Motorcycle Accident data and the smash estimates (with the dashed red lines showing the confidence intervals).
plot(res.mc$x,res.mc$mu.est,type = "l",
ylim = c(min(res.mc$y - 2 * sqrt(res.mc$var.est)),
max(res.mc$y + 2 * sqrt(res.mc$var.est))),
xlab = "time (ms)", ylab = "acceleration (g)",lwd = 2,
col = "darkorange",xlim = c(0,60),xaxp = c(0,60,6))
lines(res.mc$x, res.mc$mu.est + 2*sqrt(res.mc$var.est),lty = 5,
lwd = 2,col = "dodgerblue")
lines(res.mc$x,res.mc$mu.est - 2*sqrt(res.mc$var.est),
lty = 5,lwd = 2,col = "dodgerblue")
points(res.mc$x,res.mc$y,pch = 1,cex = 1,col = "black")
Apply SMASH (assuming equal variances) to the Motorcycle Accident data set.
res.cons.mc <- smash.cons.wrapper(x.ini.mc,y.ini.mc)
Apply TI thresholding to the Motorcycle Accident data set.
res.ti.cons.mc <- tithresh.cons.wrapper(x.ini.mc,y.ini.mc)
Apply TI thresholding to the Motorcycle Accident data, this time using the variances estimated by SMASH.
res.ti.mc <- tithresh.wrapper(x.ini.mc,y.ini.mc)
In this second plot, we compare the mean estimate provided by SMASH (with heteroskedastic variances; orange line) against homoskedastic SMASH (dotted, light blue line).
plot(res.mc$x,res.mc$mu.est,type = "l",
ylim = c(min(res.mc$y - 2 * sqrt(res.mc$var.est)),
max(res.mc$y + 2 * sqrt(res.mc$var.est))),
xlab = "time (ms)",ylab = "acceleration (g)",lwd = 2,
col = "darkorange",xlim = c(0,60),xaxp = c(0,60,6))
lines(res.cons.mc$x,res.cons.mc$mu.est,lwd = 2,lty = "dotted",
col = "dodgerblue")
points(res.mc$x,res.mc$y,pch = 1,cex = 0.8,col = "black")
And in this next plot, we compare the SMASH estimates (the orange line) against the the mean estimates obtained by TI thresholding (dark blue line), and TI thresholding when the variances have been estimated by SMASH (dotted green line).
plot(res.mc$x,res.mc$mu.est,type = "l",
ylim = c(min(res.mc$y - 2 * sqrt(res.mc$var.est)),
max(res.mc$y + 2 * sqrt(res.mc$var.est))),
xlab = "time (ms)",ylab = "acceleration (g)",lwd = 2,
col = "darkorange",xlim = c(0,60),xaxp = c(0,60,6))
lines(res.ti.cons.mc$x,res.ti.cons.mc$mu.est,lwd = 2,lty = "solid",
col = "darkblue")
lines(res.ti.mc$x,res.ti.mc$mu.est,lwd = 2,col = "limegreen",lty = "dotted")
points(res.mc$x,res.mc$y,pch = 1,cex = 0.8,col = "black")
The TI thresholding estimate and the SMASH estimate with homoskedastic variances both show notable artifacts. When the TI thresholding method is provided with the SMASH variance estimate, the mean signal is substantially smoother.
sessionInfo()
# R version 3.6.1 (2019-07-05)
# Platform: x86_64-w64-mingw32/x64 (64-bit)
# Running under: Windows 10 x64 (build 17134)
#
# Matrix products: default
#
# locale:
# [1] LC_COLLATE=English_United States.1252
# [2] LC_CTYPE=English_United States.1252
# [3] LC_MONETARY=English_United States.1252
# [4] LC_NUMERIC=C
# [5] LC_TIME=English_United States.1252
#
# attached base packages:
# [1] stats graphics grDevices utils datasets methods base
#
# other attached packages:
# [1] EbayesThresh_1.4-12 wavethresh_4.6.8 smashr_1.2-5
# [4] lattice_0.20-38 MASS_7.3-51.4
#
# loaded via a namespace (and not attached):
# [1] Rcpp_1.0.2 knitr_1.25 whisker_0.4
# [4] magrittr_1.5 workflowr_1.4.0 pscl_1.5.2
# [7] doParallel_1.0.15 SQUAREM_2017.10-1 rlang_0.4.0
# [10] foreach_1.4.7 ashr_2.2-39 stringr_1.4.0
# [13] caTools_1.17.1.2 tools_3.6.1 parallel_3.6.1
# [16] grid_3.6.1 data.table_1.12.6 xfun_0.10
# [19] git2r_0.26.1 iterators_1.0.12 htmltools_0.4.0
# [22] yaml_2.2.0 rprojroot_1.3-2 digest_0.6.21
# [25] mixsqp_0.2-2 Matrix_1.2-17 bitops_1.0-6
# [28] codetools_0.2-16 fs_1.3.1 glue_1.3.1
# [31] evaluate_0.14 rmarkdown_1.16 stringi_1.4.3
# [34] compiler_3.6.1 backports_1.1.5 truncnorm_1.0-8