Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Nov 21, 2024
1 parent 75a14df commit 596f81c
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 23 deletions.
18 changes: 10 additions & 8 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Sys.setenv(LANGUAGE = "en") # Force locale

<!-- badges: start -->
[![R-CMD-check](https://github.com/tesselle/kairos/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/kairos/actions)
[![codecov](https://codecov.io/gh/tesselle/kairos/branch/master/graph/badge.svg)](https://app.codecov.io/gh/tesselle/kairos)
[![codecov](https://codecov.io/gh/tesselle/kairos/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tesselle/kairos)
[![CodeFactor](https://www.codefactor.io/repository/github/tesselle/kairos/badge)](https://www.codefactor.io/repository/github/tesselle/kairos)
[![Dependencies](https://tinyverse.netlify.app/badge/kairos)](https://cran.r-project.org/package=kairos)

Expand All @@ -36,13 +36,14 @@ Sys.setenv(LANGUAGE = "en") # Force locale

## Overview

A convenient and reproducible toolkit for relative and absolute dating and analysis of chronological patterns. This package includes functions for chronological modeling and dating of archaeological assemblages from count data. It provides methods for matrix seriation. It also allows to compute time point estimates and density estimates of the occupation and duration of an archaeological site. **kairos** provides methods for:
A toolkit for relative and absolute dating and analysis of chronological patterns. This package includes functions for chronological modeling and dating of archaeological assemblages from count data. It provides methods for matrix seriation. It also allows to compute time point estimates and density estimates of the occupation and duration of an archaeological site. **kairos** provides methods for:

* Matrix seriation: `seriate_rank()` and `seriate_average()`
* Mean ceramic date estimation [@south1977]: `mcd()`
* Event and accumulation date estimation [@bellanger2012]: `event()`
* Aoristic analysis [@ratcliffe2000]: `aoristic()`
* Chronological apportioning [@roberts2012]: `apportion()`
* Matrix seriation: `seriate_rank()` and `seriate_average()`.
* Testing matrix seriation results [@porcic2013; @peeples2012]: `assess()` and `refine()`.
* Mean ceramic date estimation [@south1977]: `mcd()`.
* Event and accumulation date estimation [@bellanger2012]: `event()`.
* Aoristic analysis [@ratcliffe2000]: `aoristic()`.
* Chronological apportioning [@roberts2012]: `apportion()`.

[**tabula**](https://packages.tesselle.org/tabula/) is a companion package to **kairos** that provides functions for visualization and analysis of archaeological count data.

Expand Down Expand Up @@ -75,7 +76,7 @@ remotes::install_github("tesselle/kairos")
library(kairos)
```

**kairos** v2.0 uses **aion** for internal date representation. Look at `vignette("aion")` before you start.
**kairos** uses [**aion**](https://packages.tesselle.org/aion/) for internal date representation. Look at `vignette("aion", package = "aion")` before you start.

*It assumes that you keep your data tidy*: each variable (type/taxa) must be saved in its own column and each observation (sample/case) must be saved in its own row.

Expand All @@ -95,6 +96,7 @@ ao <- aoristic(loire_range, step = 50, weight = TRUE, groups = loire$area)
plot(ao, col = "grey")
## Rate of change by group
set.seed(12345) # Set seed for reproductibility
ro <- roc(ao, n = 30)
plot(ro)
```
Expand Down
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<!-- badges: start -->

[![R-CMD-check](https://github.com/tesselle/kairos/workflows/R-CMD-check/badge.svg)](https://github.com/tesselle/kairos/actions)
[![codecov](https://codecov.io/gh/tesselle/kairos/branch/master/graph/badge.svg)](https://app.codecov.io/gh/tesselle/kairos)
[![codecov](https://codecov.io/gh/tesselle/kairos/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tesselle/kairos)
[![CodeFactor](https://www.codefactor.io/repository/github/tesselle/kairos/badge)](https://www.codefactor.io/repository/github/tesselle/kairos)
[![Dependencies](https://tinyverse.netlify.app/badge/kairos)](https://cran.r-project.org/package=kairos)

Expand Down Expand Up @@ -36,19 +36,21 @@ developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.re

## Overview

A convenient and reproducible toolkit for relative and absolute dating
and analysis of chronological patterns. This package includes functions
for chronological modeling and dating of archaeological assemblages from
count data. It provides methods for matrix seriation. It also allows to
compute time point estimates and density estimates of the occupation and
duration of an archaeological site. **kairos** provides methods for:

- Matrix seriation: `seriate_rank()` and `seriate_average()`
- Mean ceramic date estimation (South 1977): `mcd()`
A toolkit for relative and absolute dating and analysis of chronological
patterns. This package includes functions for chronological modeling and
dating of archaeological assemblages from count data. It provides
methods for matrix seriation. It also allows to compute time point
estimates and density estimates of the occupation and duration of an
archaeological site. **kairos** provides methods for:

- Matrix seriation: `seriate_rank()` and `seriate_average()`.
- Testing matrix seriation results (Porčić 2013; Peeples and Schachner
2012): `assess()` and `refine()`.
- Mean ceramic date estimation (South 1977): `mcd()`.
- Event and accumulation date estimation (Bellanger and Husi 2012):
`event()`
- Aoristic analysis (Ratcliffe 2000): `aoristic()`
- Chronological apportioning (Roberts et al. 2012): `apportion()`
`event()`.
- Aoristic analysis (Ratcliffe 2000): `aoristic()`.
- Chronological apportioning (Roberts et al. 2012): `apportion()`.

[**tabula**](https://packages.tesselle.org/tabula/) is a companion
package to **kairos** that provides functions for visualization and
Expand Down Expand Up @@ -91,8 +93,9 @@ library(kairos)
#> Loading required package: dimensio
```

**kairos** v2.0 uses **aion** for internal date representation. Look at
`vignette("aion")` before you start.
**kairos** uses [**aion**](https://packages.tesselle.org/aion/) for
internal date representation. Look at
`vignette("aion", package = "aion")` before you start.

*It assumes that you keep your data tidy*: each variable (type/taxa)
must be saved in its own column and each observation (sample/case) must
Expand All @@ -119,6 +122,7 @@ plot(ao, col = "grey")
``` r

## Rate of change by group
set.seed(12345) # Set seed for reproductibility
ro <- roc(ao, n = 30)
plot(ro)
```
Expand Down
Binary file modified man/figures/README-aoristic-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 596f81c

Please sign in to comment.