https://github.com/archaeostat/archaeocal

An R Interface to OxCal

https://github.com/archaeostat/archaeocal

Keywords

Repository

An R Interface to OxCal

README.Rmd

---
output: github_document
bibliography: inst/bibliography.bib
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# ArchaeoCal


[![R-CMD-check](https://github.com/ArchaeoStat/ArchaeoCal/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ArchaeoStat/ArchaeoCal/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/ArchaeoStat/ArchaeoCal/branch/main/graph/badge.svg?token=fXOWoBzKIw)](https://app.codecov.io/gh/ArchaeoStat/ArchaeoCal)

[![r-universe](https://archaeostat.r-universe.dev/badges/ArchaeoCal)](https://archaeostat.r-universe.dev){.pkgdown-devel}
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)


## Overview

## Installation

You can install the latest version of **ArchaeoCal** from [our repository](https://ArchaeoStat.r-universe.dev) with:

```{r universe-installation, eval=FALSE}
options(repos = c(CRAN = "https://cloud.r-project.org",
                  universe = "https://archaeostat.r-universe.dev"))

install.packages("ArchaeoCal")
```

And the development version from [GitHub](https://github.com/) with:

```{r gh-installation, eval=FALSE}
# install.packages("remotes")
remotes::install_github("ArchaeoStat/ArchaeoCal")
```

## Usage

This example uses data available through the [**ArchaeoData**](https://github.com/ArchaeoStat/ArchaeoData) package which is available in a [separate repository](https://archaeostat.r-universe.dev). **ArchaeoData** provides OxCal [@bronkramsey2009] input models.

```{r ArchaeoData, eval=FALSE}
## Install the latest version
install.packages("ArchaeoData", repos = "https://archaeostat.r-universe.dev")
```

```{r setup, eval=FALSE}
## Load package
library(ArchaeoCal)

## Download OxCal
oxcal_configure(ask = FALSE)
```

```{r excute, eval=FALSE}
## Construct the path to the OxCal script
path <- file.path("oxcal", "ksarakil", "ksarakil.oxcal")
file <- system.file(path, package = "ArchaeoData")

## Read the script from Bosch et al. 2015
scr <- readLines(file)

## Print
# cat(scr, sep = "\n")

## Execute
## /!\ this may take a while /!\
out <- oxcal_execute(scr, file = "path/to/my/results")

## Parse OxCal output
res <- oxcal_parse(out)
```

## References

Owner

GitHub Events