https://github.com/joeroe/rintchron

R Interface to IntChron
https://github.com/joeroe/rintchron

archaeology opendata r r-package radiocarbon-dates rstats

Last synced: 17 days ago
JSON representation

R Interface to IntChron

• Host: GitHub
• URL: https://github.com/joeroe/rintchron
• Owner: joeroe
• License: other
• Created: 2020-10-11T17:55:22.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-26T06:45:27.000Z (over 1 year ago)
• Last Synced: 2024-11-23T12:51:53.828Z (about 1 month ago)
• Topics: archaeology, opendata, r, r-package, radiocarbon-dates, rstats
• Language: R
• Homepage: https://rintchron.joeroe.io
• Size: 896 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE
  • Codemeta: codemeta.json

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# rintchron: R interface to IntChron 

[![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)

[![CRAN status](https://www.r-pkg.org/badges/version/rintchron)](https://CRAN.R-project.org/package=rintchron)

[![R-CMD-check](https://github.com/joeroe/rintchron/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/joeroe/rintchron/actions/workflows/R-CMD-check.yaml)

**rintchron** provides an R interface to [IntChron](https://intchron.org), an indexing service and exchange format for radiocarbon dates and other chronological data ([Bronk Ramsey et al. 2019](https://doi.org/10.1017/RDC.2019.21)).

It includes a user friendly interface for querying databases indexed by IntChron, as well as lower level functions for interacting directly with the [IntChron API](https://intchron.org/schema).

For an introduction to querying IntChron's databases see the [basic usage vignette](https://rintchron.joeroe.io/articles/rintchron).

For advanced users, low level functions for interacting with the IntChron API directly are described in the [IntChron API vignette](https://rintchron.joeroe.io/articles/intchron_api).

## Installation

rintchron has not yet been released on CRAN.

You can install the development version from GitHub using the [remotes](https://remotes.r-lib.org/) package: 

```{r intchron-install, eval=FALSE}

# install.package("remotes")

remotes::install_github("joeroe/rintchron")

```

## Usage

Use [`intchron()`](https://rintchron.joeroe.io/reference/intchron) to query databases indexed by IntChron.

You can refine the query by database (use `intchron_hosts()` to see what's available) and optionally by country and site.

For example, to download records from Jordan in the ORAU and NERC Radiocarbon Facility databases:

```{r intchron-basic}

library("rintchron")

# List available databases

intchron_hosts()

# Query IntChron

intchron(c("oxa", "nrcf"), countries = "Jordan")

```