Learn R Programming

oxcAAR

oxcAAR (previously named roxcal) is a collection of functions that can be used to execute OxCal from within R.

Please note that there is a roxcal package package on GitHub, created by Gavin Simpson. If you just need to import OxCal result files, you may consider using his package.

License

oxcAAR is released under the GNU General Public License, version 2. Comments and feedback are welcome, as are code contributions.

Installation

To install the stable version from CRAN:

install.packages('oxcAAR')

To install the latest development version:

if(!require('devtools')) install.packages('devtools')
library(devtools)
install_github('ISAAKiel/oxcAAR')

Get started

To get started, just run:

quickSetupOxcal()

This will download and unzip OxCal into tempdir(). You can change the destination path of OxCal by setting the path parameter. Please make sure that you have a working internet connection when attempting to use this function!

Afterwards you can start calibrating your dates. Check the Vignette to learn how to do this.

Copy Link

Version

Install

install.packages('oxcAAR')

Monthly Downloads

213

Version

1.1.1

License

GPL-2 | file LICENSE

Maintainer

Martin Hinz

Last Published

July 5th, 2021

Functions in oxcAAR (1.1.1)

Phase

Returns the Oxcal code for Phase
get_name

get names (labcodes)
calcurve_plot

Plots calibrated dates on the calibration curve
R_Simulate

Returns the Oxcal code for the simulation of 14C dates
R_Date

Returns the Oxcal code for the calibration of 14C dates
get_cal_curve

get calibration curve names
Boundary

Returns the Oxcal code for a Boundary
Sequence

Returns the Oxcal code for Sequence
executeOxcalScript

Executes an Oxcal Script
get_bp

get bp values (ages)
quickSetupOxcal

Quick OxCal setup
oxcAARCalibratedDatesList

oxcAAR Calibrated Dates List
oxcAARCalibratedDate

oxcAAR Calibrated Dates Object
readOxcalOutput

Reads the content of the Oxcal js output file
get_sigma_ranges

get sigma ranges
parseOxcalOutput

Parses an Oxcal Output File into R
get_raw_probabilities

get raw probabilities
parseFullOxcalOutput

Parses an Oxcal Output File completely into R
oxcalSumSim

Sum calibration for simulated dates
oxcal_Sum

Wraps an Oxcal string into a Oxcal sum function
is.oxcAARCalibratedDatesList

Checks if a variable is of class oxcAARCalibratedDatesList
is.oxcAARCalibratedDate

Checks if a variable is of class oxcAARCalibratedDate
get_std

get std values (standard deviations)
get_tidy_oxcalresult

tidy output
setOxcalExecutablePath

Setting the Oxcal program path for further use
get_posterior_sigma_ranges

get posterior sigma ranges
oxcalCalibrate

Calibrates a 14C date using oxcal
get_posterior_probabilities

get posterior raw probabilities
wrap_in_boundaries

Wrap OxCal commands in Boundary commands
oxcalSimulate

Simulates 14C dates using oxcal