Skip to content

Latest commit

 

History

History
113 lines (73 loc) · 3.8 KB

README.md

File metadata and controls

113 lines (73 loc) · 3.8 KB

admtools

R package to estimate age-depth models from stratigraphic and sedimentological data, and transform complex data between the time and stratigraphic domain.

R-CMD-check fair-software.eu DOI

Authors

Niklas Hohmann
Utrecht University
email: n.h.hohmann [at] uu.nl
Web page: uu.nl/staff/NHohmann
Orcid: 0000-0003-1559-1838

Installation

You can install the package from CRAN. For this, run

install.packages("admtools")

in R. To install the package from GitHub, first install the remotes package

install.packages("remotes")

Then, run

remotes::install_github(repo = "MindTheGap-ERC/admtools",
                        build_vignettes = TRUE,
                        ref = "HEAD",
                        dependencies = TRUE)

To install the latest stable version. To install the version under development, use

remotes::install_github(repo = "MindTheGap-ERC/admtools",
                        build_vignettes = TRUE,
                        ref = "dev",
                        dependencies = TRUE)

After installation, you can load the package using

library("admtools")

To get started, have a look at the available vignettes via

browseVignettes(package = "admtools") # opens in Browser
#or
vignette(package = "admtools")

A good place to start reading is the introductory vignette, available via

vignette("admtools")

License

GPL-3.0, see LICENSE file for license text.

Copyright

Copyright 2023 Netherlands eScience Center and Utrecht University

Contribution

For contribution guidelines see the CONTRIBUTING.md file

Citation

To cite the package, use

or run

citation("admtools")

in R. Alternatively, you can use the information in the CITATION.cff file, or generate it using the "cite this repository" button on GitHub.

References

This package uses data from

  • Hohmann, Niklas; Koelewijn, Joël R.; Burgess, Peter; Jarochowska, Emilia. 2024. "Identification of the mode of evolution in incomplete carbonate successions." BMC Ecology and Evolution, 24, 113. DOI: 10.1186/s12862-024-02287-2.

  • Hohmann, Niklas, Koelewijn, Joël R.; Burgess, Peter; Jarochowska, Emilia. 2023. "Identification of the Mode of Evolution in Incomplete Carbonate Successions - Supporting Data." Open Science Framework. https://doi.org/10.17605/OSF.IO/ZBPWA, published under the CC-BY 4.0 license.

Funding information

The authors acknowledge the contribution of the CycloNet project, funded by the Research Foundation Flanders (FWO, grant no. W000522N)

Funded by the European Union (ERC, MindTheGap, StG project no 101041077). Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Research Council. Neither the European Union nor the granting authority can be held responsible for them. European Union and European Research Council logos