https://github.com/benmarwick/steele_et_al_vr003_msa_pigments
https://github.com/benmarwick/steele_et_al_vr003_msa_pigments
compendium reproducible-paper research-compendium
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/benmarwick/steele_et_al_vr003_msa_pigments
- Owner: benmarwick
- Created: 2015-01-23T00:33:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-30T12:52:46.000Z (about 9 years ago)
- Last Synced: 2025-01-13T17:03:23.990Z (3 months ago)
- Topics: compendium, reproducible-paper, research-compendium
- Language: R
- Size: 11.6 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
Awesome Lists containing this project
README
---
output:
md_document:
variant: markdown_github
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# Steele_et_al_VR003_MSA_Pigments
### Author
Ben Marwick ([email protected])
### Contents
This repository contains the research compendium of our work on mineral pigments from Middle Stone Age archaeological sites in South Africa. The compendium contains all data, code, and text associated with this section of the publication (which is currently under review).
### How to use
#### Read the manuscript
See the [`vignettes`](https://github.com/benmarwick/Steele_et_al_VR003_MSA_Pigments/tree/master/vignettes) directory here on GitHub for source code and data for the manuscript.
#### Install the R package
[](https://travis-ci.org/benmarwick/Steele_et_al_VR003_MSA_Pigments.svg)
This repository is organized as an R package, providing functions and raw data to reproduce and extend the analysis reported in the publication. Note that this package has been written explicitly for this project and may not be suitable for more general use. To download the package source as you see it here on GitHub, for offline browsing, use this line at the shell prompt:
```{r eval=FALSE}
git clone https://github.com/benmarwick/Steele_et_al_VR003_MSA_Pigments.git
```
Or to install, build and use the package within R, use this line at the R prompt:
```{r eval=FALSE}
devtools::install_github("benmarwick/Steele_et_al_VR003_MSA_Pigments", build_vignettes = TRUE)
```
Then you can read the manuscript using this line at the R prompt:
```{r, eval=FALSE}
browseVignettes("SteeleVR003MSAPigments")
```
This R package has several depedencies that are listed below, some of which need to be installed manually if using this package from your local R installation.
#### Run the Docker container
[](https://circleci.com/gh/benmarwick/Steele_et_al_VR003_MSA_Pigments)
This compendium is also available as a [Docker](https://docs.docker.com/installation) container. The advantage of this format is that it includes this package and all its dependencies already installed, so you don't have to worry about those. OSX & Windows users should launch [`boot2docker`](http://boot2docker.io/) to access the Docker terminal, Linux users can just open any terminal). You can either generate the Docker container yourself using the [Dockerfile](https://github.com/benmarwick/Steele_et_al_VR003_MSA_Pigments/blob/master/vignettes/Dockerfile) included here, or for a quicker start, pull the image from the [online registry](https://registry.hub.docker.com/u/benmarwick/steeleetalvr003msapigments/) and run the container using this line at the Docker prompt:
```{r eval=FALSE}
docker run -dp 8787:8787 benmarwick/steeleetalvr003msapigments
```
Then you can interact with RStudio via your browser at localhost:8787 (on Linux) or http://192.168.59.103:8787/ (on Windows/OSX, or whatever address you get from `boot2docker ip` at the shell prompt). Log in to RStudio with user: `rstudio` and password: `rstudio`. See the [rocker-org Wiki](https://github.com/rocker-org/rocker/wiki/Using-the-RStudio-image) for more details. In RStudio you'll see the `Rmd` file for the manuscript and a directory for the raw data. You can knit the `Rmd` file to produce the HTML file that reproduces the text, plots and other results of the analysis. You can also edit and run the `Rmd` interactively in RStudio to explore the analysis further.
### Licenses:
Manuscript: CC-BY-4.0 http://creativecommons.org/licenses/by/4.0/
Code: MIT http://opensource.org/licenses/MIT year: 2014, copyright holder: Ben Marwick)
Data: CC0 http://creativecommons.org/publicdomain/zero/1.0/
### Notes and resources ##
* The [issues tracker](https://github.com/benmarwick/Steele_et_al_VR003_MSA_Pigments) is the place to report problems or ask questions
* See the repository [history](https://github.com/benmarwick/Steele_et_al_VR003_MSA_Pigments/commits/master) for a fine-grained view of progress and changes.
* The organisation of this compendium is based on the work of [Carl Boettiger](http://www.carlboettiger.info/)
### R Session Information
```{r, eval=FALSE}
R version 3.1.2 (2014-10-31)
Platform: x86_64-w64-mingw32/x64 (64-bit)
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] splines grid stats graphics grDevices utils datasets
[8] methods base
other attached packages:
[1] SteeleVR003MSAPigments_0.1 cluster_1.15.3
[3] fpc_2.1-9 ggbiplot_0.55
[5] scales_0.2.4 BayesianFirstAid_0.1
[7] rjags_3-14 coda_0.16-1
[9] ggplot2_1.0.0 Hmisc_3.14-6
[11] Formula_1.1-2 survival_2.37-7
[13] lattice_0.20-29 reshape2_1.4.1
[15] Bolstad2_1.0-28 dplyr_0.4.0
[17] kfigr_1.0.1 knitr_1.8
[19] devtools_1.7.0.9000 stringr_0.6.2
[21] plyr_1.8.1
loaded via a namespace (and not attached):
[1] acepack_1.3-3.3 assertthat_0.1 bitops_1.0-6
[4] class_7.3-11 colorspace_1.2-4 DBI_0.3.1
[7] DEoptimR_1.0-2 digest_0.6.8 diptest_0.75-6
[10] evaluate_0.5.5 flexmix_2.3-12 foreign_0.8-61
[13] formatR_1.0 gtable_0.1.2 htmltools_0.2.6
[16] httr_0.6.1 kernlab_0.9-20 latticeExtra_0.6-26
[19] magrittr_1.5 MASS_7.3-35 mclust_4.4
[22] modeltools_0.2-21 munsell_0.4.2 mvtnorm_1.0-2
[25] nnet_7.3-8 parallel_3.1.2 prabclus_2.2-5
[28] proto_0.3-10 RColorBrewer_1.1-2 Rcpp_0.11.3
[31] RCurl_1.95-4.5 rmarkdown_0.5.0.1 robustbase_0.92-2
[34] rpart_4.1-8 stats4_3.1.2 tools_3.1.2
[37] trimcluster_0.1-2 yaml_2.1.13
```