README.Rmd

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

<!-- 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 = "100%"
)
```

# ArchaeoCal

<!-- badges: start -->
[![R-CMD-check](https://github.com/ArchaeoStat/ArchaeoCal/workflows/R-CMD-check/badge.svg)](https://github.com/ArchaeoStat/ArchaeoCal/actions)
[![codecov](https://codecov.io/gh/ArchaeoStat/ArchaeoCal/branch/main/graph/badge.svg?token=fXOWoBzKIw)](https://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)
<!-- badges: end -->

## Overview

## Installation

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

```{r universe-installation, eval=FALSE}
install.packages("ArchaeoCal", repos = "https://archaeostat.r-universe.dev")
```

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

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

## Usage

```{r packages-load}
## Load packages
library(ArchaeoCal)
```