p3k14c

This repository contains the data and code for our paper:

Darcy Bird , Lux Miranda , Marc Vander Linden , Robinson, Erick , R. Kyle Bocinsky , Chris Nicholson , José M. Capriles , Judson Byrd Finley , Eugenia M. Gayo , Adolfo Gil , Jade d’Alpoim Guedes , Julie A. Hoggarth , Andrea Kay , Emma Loftus , Umberto Lombardo , Madeline Mackie , Alessio Palmisano , Steinar Solheim , Robert L. Kelly, and Jacob Freeman .

(2021) p3k14c: A synthetic global database of archaeological radiocarbon dates.

Contents

The :file_folder: vignettes/articles directory contains:

  • :page_facing_up: p3k14c: R Markdown source document for the manuscript. Includes code to reproduce the figures and tables generated by the analysis. It also has a rendered version, p3k14c.html, suitable for reading (the code is replaced by figures and tables in this file).
  • :file_folder: figures: Plots and other illustrations
  • :file_folder: tables: Tables included in the paper

How to run in your browser or download and run locally

The simplest way to explore the text, code and data is to click on binder to open an instance of RStudio in your browser, which will have the compendium files ready to work with. Binder uses (rocker-project.org)rocker − project.orgDocker images to ensure a consistent and reproducible computational environment. These Docker images can also be used locally.

You can download the compendium as a zip from from this URL: main.zip. After unzipping, open the Proj file in RStudio, and run devtools::install() to ensure you have the packages this analysis depends on (also listed in the DESCRIPTION file). Then open p3k14c.Rmd and knit to produce the paper in PDF format.

Installation

You can install the released version of p3k14c from Github with:

# install.packages("remotes")
remotes::install_github("people3k/p3k14c@1.0.0")

Executable research compendium

You are required to have a copy of the raw p3k14c dataset, available through tDAR at https://doi.org/10.48512/XCV8459173. Clone this repository, then place the p3k14c_raw.csv at ../p3k14c-data/p3k14c_raw.csv, relative to the working director of the cloned repository.

You can do so thus:

git clone https://github.com/people3k/p3k14c
cd p3k14c

You can compile the research compendium through the terminal:

R -e "rmarkdown::render('vignettes/articles/p3k14c.Rmd', output_dir = 'vignettes/articles')"

or, within R itself:

rmarkdown::render('vignettes/articles/p3k14c.Rmd', output_dir = 'vignettes/articles')

Accessing the scrubbed/fuzzed p3k14c dataset

Once the p3k14c package is installed, you can access the scrubbed/fuzzed p3k14c via R:

How to cite

Please cite this compendium as:

Bocinsky, R. Kyle, Darcy Bird, and Erick Robinson, (2020). Compendium of R code and data for p3k14c: A synthetic global database of archaeological radiocarbon dates. Accessed TODAY′SDATE.

Licenses

Text and figures : CC-BY-4.0

Code : GNU GPLv3

Data : CC-0 attribution requested in reuse

Contributions

We welcome contributions from everyone. Before you get started, please see our contributor guidelines. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Acknowledgements

This compendium was created using the rrtools package by Ben Marwick, which is ✨ pure magic ✨ for doing reproducible research.

Code of Conduct

Please note that the p3k14c project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.