Public | Automated Build

Last pushed: 2 years ago
Short Description
To capture the complete computational environment used for this project.
Full Description

<!-- README.md is generated from README.Rmd. Please edit that file -->

Research compendium for a report on the stone artefacts from Jerimalai, East Timor

Compendium DOI:

http://dx.doi.org/10.6084/m9.figshare.985406

The files at the URL above will generate the results as found in the publication. The files hosted at https://github.com/benmarwick/Pleistocene-aged-stone-artefacts-from-Jerimalai--East-Timor are the development versions and may have changed since the report was published

Author of this repository:

Ben Marwick (benmarwick@gmail.com)

Published in:

Marwick, B, C. Clarkson, S. O'Connor & S. Collins 2016 "Pleistocene-aged stone artefacts from Jerimalai, East Timor: Long term conservatism in early modern human technology in island Southeast Asia" Journal of Human Evolution pre-print: https://osf.io/63zey/

Overview of contents

This repository is our research compendium for our analysis of the stone artefacts from Sue O'Connor's excavations at Jerimalai, East Timor. The compendium contains all data, code, and text associated with the publication. The Rmd files in the manuscript/ directory contain details of how all the analyses reported in the paper were conducted, as well as instructions on how to rerun the analysis to reproduce the results. The data/ directory in the manuscript/ directory contains all the raw data.

The supplementary files

The manuscript/ directory contains:

  • all the data files (in CSV format, in the data/ directory)
  • the manuscript as submitted (in MS Word format)
  • supplementary information source files (in R markdown format)
  • executed versions of the supplementary files (in HTML format) and all the figures that are included in the paper (in the figures/ directory)

The R package

This repository is organized as an R package, providing the main functions compute to Bayesian tests of credible difference. These functions are provided as a package because this makes it simpler to reuse the functions many times in the paper. It also makes it easier for others to use and adapt these functions on their own data. Nevertheless, this package has been written explicitly for this project and may not yet be suitable for more general purpose use.

To download the package source as you see it on GitHub, for offline browsing, use this line at the shell prompt (assuming you have Git installed on your computer):

git clone https://github.com/benmarwick/Pleistocene-aged-stone-artefacts-from-Jerimalai--East-Timor.git

Once the download is complete, open the Marwick-et-al-Jeremalai-lithics-2014.Rproj in RStudio to begin working with the package and compendium files.

If you just want to use the Bayesian inference functions included here, you can install the R package directly (without obtaining the compendium files) in R with this line at the R prompt:

# install.packages("devtools") # which in turn requires Rtools (if Windows) or Xcode (if OSX)
devtools::install_github("benmarwick/Pleistocene-aged-stone-artefacts-from-Jerimalai--East-Timor")

The package has a number of dependencies on other R packages, and programs outside of R. These are listed at the bottom of this README. Installing these can be time-consuming and complicated, so to simpify access to the compendium we also provide at Docker image that includes all the necessary software, code and data to run our analysis.

The Docker image

A Docker image is a lightweight GNU/Linux virtual computer that can be run as a piece of software on Windows and OSX (and other Linux systems). To capture the complete computational environment used for this project we have a Dockerfile that specifies how to make the Docker image that we developed this project in. The Docker image includes all of the software dependencies needed to run the code in this project, as well as the R package and other compendium files. To launch the Docker image for this project, first, install Docker on your computer. OSX & Windows users should launch boot2docker to access the Docker terminal, Linux users can just open any terminal). At the Docker prompt, enter:

docker run -dp 8787:8787 benmarwick/jerimalaistoneartefacts

This will start a server instance of RStudio. Then open your web browser at localhost:8787 or or run docker-machine ip default in the shell to find the correct IP address, and log in with rstudio/rstudio.

Once logged in, use the Files pane (bottom right) to navigate to / (the root directory), then open the folder for this project, and open the .Rproj file for this project. Once that's open, you'll see the manuscript/ directory in the Files pane where you can find the R markdown documents, and knit them to produce the results in the paper. More information about using RStudio in Docker is avaiable at the Rocker wiki pages.

We developed and tested the package on this Docker container, so this is the only platform that We're confident it works on, and so recommend to anyone wanting to use this package to generate the vignette, etc.

Licenses:

Manuscript: CC-BY-4.0 http://creativecommons.org/licenses/by/4.0/

Code: MIT http://opensource.org/licenses/MIT year: 2015, copyright holder: Ben Marwick

Data: CC0 http://creativecommons.org/publicdomain/zero/1.0/ attribution requested in reuse

Dependencies:

I used RStudio (version 0.98.953) on Ubuntu 14.04 and these packages:

Identified using sessionInfo():

#> Session info --------------------------------------------------------------
#>  setting  value                       
#>  version  R version 3.3.1 (2016-06-21)
#>  system   x86_64, mingw32             
#>  ui       RTerm                       
#>  language (EN)                        
#>  collate  English_Australia.1252      
#>  tz       America/Los_Angeles         
#>  date     2016-09-18
#> Packages ------------------------------------------------------------------
#>  package    * version  date       source                            
#>  assertthat   0.1      2013-12-06 CRAN (R 3.2.2)                    
#>  devtools     1.12.0   2016-06-24 CRAN (R 3.3.1)                    
#>  digest       0.6.10   2016-08-02 CRAN (R 3.3.1)                    
#>  evaluate     0.9      2016-04-29 CRAN (R 3.3.0)                    
#>  formatR      1.4      2016-05-09 CRAN (R 3.3.0)                    
#>  htmltools    0.3.5    2016-03-21 CRAN (R 3.2.4)                    
#>  knitr        1.14     2016-08-13 CRAN (R 3.3.1)                    
#>  magrittr     1.5      2014-11-22 CRAN (R 3.3.1)                    
#>  memoise      1.0.0    2016-01-29 CRAN (R 3.2.5)                    
#>  Rcpp         0.12.7   2016-09-05 CRAN (R 3.3.1)                    
#>  rmarkdown    1.0.9013 2016-09-16 Github (rstudio/rmarkdown@5d05a39)
#>  stringi      1.1.1    2016-05-27 CRAN (R 3.3.0)                    
#>  stringr      1.1.0    2016-08-19 CRAN (R 3.3.1)                    
#>  tibble       1.2      2016-08-26 CRAN (R 3.3.1)                    
#>  withr        1.0.2    2016-06-20 CRAN (R 3.3.0)                    
#>  yaml         2.1.13   2014-06-12 CRAN (R 3.2.2)

Other system dependencies identified using dependencies::needs():

Contact:

Ben Marwick, Assistant Professor, Department of Anthropology Denny Hall 117, Box 353100, University of Washington Seattle, WA 98195-3100 USA

  1. (+1) 206.552.9450 e. bmarwick@uw.edu
  2. (+1) 206.543.3285 w. http://faculty.washington.edu/bmarwick/
Docker Pull Command
Owner
benmarwick