-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
96 lines (69 loc) · 3.37 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = NULL
)
Sys.setlocale("LC_MESSAGES", 'en_GB.UTF-8') # Force locale
```
# ananke
<!-- badges: start -->
[](https://github.com/tesselle/ananke/actions)
[](https://app.codecov.io/gh/tesselle/ananke)
[](https://www.codefactor.io/repository/github/tesselle/ananke/overview/main)
[](https://tesselle.r-universe.dev/ananke){.pkgdown-devel}
[](https://www.repostatus.org/#wip)
[](https://doi.org/10.5281/zenodo.13236285)
<!-- badges: end -->
## Overview
**ananke** provides functions for simple radiocarbon calibration and chronological analysis.
This package is currently *experimental*. This means that it is functional, but interfaces and functionalities may change over time, testing and documentation may be lacking.
---
```{r citation, echo=FALSE, comment='', results='asis'}
cite <- utils::citation("ananke")
print(cite, bibtex = FALSE)
```
## Installation
You can install the released version of **ananke** from [CRAN](https://CRAN.R-project.org) with:
```{r cran-installation, eval=FALSE}
install.packages("ananke")
```
And the development version from [GitHub](https://github.com/) with:
```{r gh-installation, eval=FALSE}
# install.packages("remotes")
remotes::install_github("tesselle/ananke")
```
## Usage
```{r packages-load}
## Load packages
library(ananke)
```
```{r calibration, fig.width=7, fig.height=7}
## Data from Bosch et al. 2015
data("ksarakil")
## Calibrate multiple dates
cal <- c14_calibrate(
values = ksarakil$date,
errors = ksarakil$error,
names = ksarakil$code,
curves = "marine13",
reservoir_offsets = 53,
reservoir_errors = 43,
from = 50000, to = 0
)
## Plot
plot(cal)
## Full text description
describe(cal, fill = TRUE)
```
## Related Works
* [**Bchron**](https://github.com/andrewcparnell/Bchron) enables quick calibration of radiocarbon dates, age-depth modelling, relative sea level rate estimation, and non-parametric phase modelling.
* [**racarbon**](https://github.com/ahb108/rcarbon) includes functions not only for basic calibration, uncalibration, and plotting of one or more dates, but also a statistical framework for building demographic and related longitudinal inferences from aggregate radiocarbon date lists.
* [**rintcal**](https://github.com/Maarten14C/rintcal) consists of a data compilation of the IntCal radiocarbon calibration curves and provides a number of functions to assist with calibrating dates and plotting calibration curves.
## Contributing
Please note that the **ananke** project is released with a [Contributor Code of Conduct](https://www.tesselle.org/conduct.html). By contributing to this project, you agree to abide by its terms.