# palaeoverse <img src="man/figures/logo.png" align="right" width="120" />

<!-- badges: start -->
[![R-CMD-check](https://github.com/palaeoverse/palaeoverse/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/palaeoverse/palaeoverse/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/palaeoverse/palaeoverse/branch/main/graph/badge.svg?token=HQQO2CRIKT)](https://app.codecov.io/gh/palaeoverse/palaeoverse)
[![CRAN status](https://www.r-pkg.org/badges/version/palaeoverse)](https://CRAN.R-project.org/package=palaeoverse)
[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/palaeoverse)](https://cran.r-project.org/package=palaeoverse)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13929873.svg)](https://doi.org/10.5281/zenodo.13929873)
[![Bluesky URL](https://img.shields.io/badge/Bluesky-0285FF?logo=bluesky&logoColor=fff&label=Follow%20%40palaeoverse)](https://bsky.app/profile/palaeoverse.bsky.social)
[![LinkedIn](https://custom-icon-badges.demolab.com/badge/LinkedIn-0A66C2?logo=linkedin-white&logoColor=fff&label=Follow%20%40Palaeoverse)](https://linkedin.com/company/palaeoverse)
[![Contributors](https://img.shields.io/github/contributors/palaeoverse/palaeoverse)](https://github.com/palaeoverse/palaeoverse/graphs/contributors)
<!-- badges: end -->

`palaeoverse` is an R package developed by palaeobiologists, for palaeobiologists.

The aim of `palaeoverse` is to generate a community-driven software package of generic functions for the palaeobiological community. The package does not provide implementations of statistical analyses, rather it provides auxiliary functions to help streamline analyses and improve code readability and reproducibility.

# Installation

The stable version of `palaeoverse` can be installed from CRAN using:

```r
install.packages("palaeoverse")
```

The development version of `palaeoverse` can be installed via GitHub using:

```r
# install.packages("devtools")
devtools::install_github("palaeoverse/palaeoverse")
```

# How to contribute?

If you are interested in contributing to the `palaeoverse` R package, you can do so by following these [guidelines](https://palaeoverse.palaeoverse.org/CONTRIBUTING.html). We have also adopted a set of [standards and structure](https://palaeoverse.palaeoverse.org/articles/structure-and-standards.html) to follow for contributing to the project. If you would like to contribute to `palaeoverse`, we strongly advise reading this document.

# Code of Conduct

As with any community project, society, or meeting we feel it is important to established some expectations of behaviour in the `palaeoverse` community. Please read our [code of conduct](https://palaeoverse.palaeoverse.org/CODE_OF_CONDUCT.html), and reach out if you ever face any issues. Everyone has the right to live and work in a harassment-free environment.

# Citation

If you use the palaeoverse R package in your work, please cite the original article describing the package:

Jones, L.A., Gearty, W., Allen, B.J., Eichenseer, K., Dean, C.D., Galván S., Kouvari, M., Godoy, P.L., Nicholl, C., Buffan, L., Dillon, E.M., Flannery-Sutherland, J.T., Chiarenza, A.A. 2023. palaeoverse: A community-driven R package to support palaeobiological analysis. *Methods in Ecology and Evolution* 14(09), 2205–2215. DOI: [10.1111/2041-210X.14099](https://doi.org/10.1111/2041-210X.14099).

And the package version you are using:

```r
# Get citation
citation("palaeoverse")
# Get citation in BibTex format
toBibtex(citation("palaeoverse"))
```

# Maintainers

- [Lewis A. Jones](mailto:LewisA.Jones@outlook.com), University College London
- [Palaeoverse](https://palaeoverse.org)

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [allcontributors](https://allcontributors.org) specification. Contributions of any kind are welcome!

<table>

<tr>
<td align="center">
<a href="https://github.com/LewisAJones">
<img src="https://avatars.githubusercontent.com/u/41071747?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=LewisAJones">LewisAJones</a>
</td>
<td align="center">
<a href="https://github.com/willgearty">
<img src="https://avatars.githubusercontent.com/u/7232514?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=willgearty">willgearty</a>
</td>
<td align="center">
<a href="https://github.com/KEichenseer">
<img src="https://avatars.githubusercontent.com/u/40391500?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=KEichenseer">KEichenseer</a>
</td>
<td align="center">
<a href="https://github.com/etiennebacher">
<img src="https://avatars.githubusercontent.com/u/52219252?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=etiennebacher">etiennebacher</a>
</td>
<td align="center">
<a href="https://github.com/ChristopherDavidDean">
<img src="https://avatars.githubusercontent.com/u/17456989?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=ChristopherDavidDean">ChristopherDavidDean</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/bethany-j-allen">
<img src="https://avatars.githubusercontent.com/u/39991015?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=bethany-j-allen">bethany-j-allen</a>
</td>
<td align="center">
<a href="https://github.com/SofiaGalv">
<img src="https://avatars.githubusercontent.com/u/80039061?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=SofiaGalv">SofiaGalv</a>
</td>
<td align="center">
<a href="https://github.com/BrunaFarina">
<img src="https://avatars.githubusercontent.com/u/82400814?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=BrunaFarina">BrunaFarina</a>
</td>
<td align="center">
<a href="https://github.com/CecilyNicholl">
<img src="https://avatars.githubusercontent.com/u/59917413?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=CecilyNicholl">CecilyNicholl</a>
</td>
<td align="center">
<a href="https://github.com/jf15558">
<img src="https://avatars.githubusercontent.com/u/50243608?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=jf15558">jf15558</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/rsbivand">
<img src="https://avatars.githubusercontent.com/u/10198404?u=130e1eda9687fabcf3606cbcbcfea79708207f7e&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=rsbivand">rsbivand</a>
</td>
<td align="center">
<a href="https://github.com/ehuangc">
<img src="https://avatars.githubusercontent.com/u/71412682?u=f6211f6b7a8e4f12077c34e1e7e701e66780a397&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=ehuangc">ehuangc</a>
</td>
<td align="center">
<a href="https://github.com/emmadunne">
<img src="https://avatars.githubusercontent.com/u/39518460?u=b60502ce9024c636176df58bdfc0724ddfe239d4&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=emmadunne">emmadunne</a>
</td>
<td align="center">
<a href="https://github.com/AlfioAlessandroChiarenza">
<img src="https://avatars.githubusercontent.com/u/26324745?u=9134936e40f06e66e14e78ab3be556e22456966e&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=AlfioAlessandroChiarenza">AlfioAlessandroChiarenza</a>
</td>
<td align="center">
<a href="https://github.com/Buffan3369">
<img src="https://avatars.githubusercontent.com/u/94531347?u=f8cdd8afbc64a157e919038535028b0af76c5073&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=Buffan3369">Buffan3369</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/pedrolgodoy">
<img src="https://avatars.githubusercontent.com/u/25245537?u=bc63170fc670a56b5fcf36084004b6b3ad2fb43f&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=pedrolgodoy">pedrolgodoy</a>
</td>
<td align="center">
<a href="https://github.com/mcnikolic">
<img src="https://avatars.githubusercontent.com/u/205835975?u=0372290737e76322231e602d7e8f91cec6123c53&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=mcnikolic">mcnikolic</a>
</td>
<td align="center">
<a href="https://github.com/obrl-soil">
<img src="https://avatars.githubusercontent.com/u/17308388?u=90c895e739a5666dfb77c009600a17d3f715920b&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=obrl-soil">obrl-soil</a>
</td>
<td align="center">
<a href="https://github.com/michaelchin">
<img src="https://avatars.githubusercontent.com/u/2688316?u=d1a43ac8b8b7288570ad68a59c875440106b9b73&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=michaelchin">michaelchin</a>
</td>
<td align="center">
<a href="https://github.com/RussellGarwood">
<img src="https://avatars.githubusercontent.com/u/1557073?u=0507bd9449b90147c95c33361ed370a508189a80&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=RussellGarwood">RussellGarwood</a>
</td>
</tr>


<tr>
<td align="center">
<a href="https://github.com/harrietdrage">
<img src="https://avatars.githubusercontent.com/u/9463417?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=harrietdrage">harrietdrage</a>
</td>
<td align="center">
<a href="https://github.com/erinmdillon">
<img src="https://avatars.githubusercontent.com/u/28285818?u=9d463d3d50a9f416a44d3a44f4fe4971529e2130&v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=erinmdillon">erinmdillon</a>
</td>
<td align="center">
<a href="https://github.com/NiklasHohmann">
<img src="https://avatars.githubusercontent.com/u/67792281?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/palaeoverse/palaeoverse/commits?author=NiklasHohmann">NiklasHohmann</a>
</td>
</tr>

</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

