Learn R Programming

admtools

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

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.

Copy Link

Version

Install

install.packages('admtools')

Monthly Downloads

629

Version

0.4.0

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Niklas Hohmann

Last Published

October 3rd, 2024

Functions in admtools (0.4.0)

L_axis_lab

plot height axis label
get_L_unit

extract length unit
max_height

get highest stratigraphic tie point
sed_rate_gen_from_bounds

seg rate gen from upper/lower bounds
anchor

anchor age-depth model
sed_rate_l

sedimentation rate in stratigraphic height
max_time

last time tie point
get_T_tp

extract time tie points
condensation_fun

condensation function
get_data_from_eTimeOpt

extract data from eTimeOpt results
get_hiat_duration

extract hiatus duration
get_height

determine stratigraphic height deposited at specific time
time_to_strat.numeric

transform vectors from time to height domain
strat_to_time.list

transform list from height to time domain
time_to_strat.phylo

transform phylo object
strat_to_time.numeric

transform numeric vectors from height to time domain
get_time

Determine times based on age-depth model
flux_quad

quadratic deterministic tracer flux
time_to_strat

transform objects from time domain to strat. domain
get_L_tp

get height/length tie point
is_destructive

Is deposition destructive?
get_T_unit

extract Time unit
is_multiadm

is valid multiadm object?
median_adm

get median ADM
plot.sac

plot sediment accumulation curve
sed_rate_l_fun

sed rate in height function
mean_adm

get mean ADM
get_hiat_list

extract hiatus info
get_total_thickness

get total thickness
get_hiat_no

get no. of hiatuses
plot.stratlist

plot strat list
get_completeness

Determine stratigraphic (in)completeness
is_sac

is valid sac objects
min_height

get lowest stratigraphic tie point
make_legend

plot legend
sed_rate_t

sedimentation rate in time domain
get_hiat_pos

get hiatus positions
merge_adm_to_multiadm

combine multiple adm ojects into multiadm object
get_total_duration

Total duration covered
is_adm

Is an adm object a valid age-depth model
summary.multiadm

summary of age-depth model
plot_erosive_intervals

mark erosive time intervals
time_to_strat.list

transform list from time to height domain
plot_sed_rate_l

plot sed. rate in height
tp_time_norm

time tie points with normal distribution
merge_multiadm

merge multiple multiadm objects
plot.timelist

plot time lists
plot.adm

plotting adm objects
plot_condensation

plot condensation in height
tp_to_adm

Construct age-depth model from tie points
split_multiadm

split multiadm objects into adm
quantile_adm

get quantile ADM
plot_sed_rate_t

plot sedimentation rate in time
plot.multiadm

plot multiadm object
min_time

first time tie point
strat_cont_gen_from_tracer

proxy values in strat domain
set_L_unit

set length units
summary.sac

summary of sediment accumulation curve
set_T_unit

set time units
strat_cont_to_multiadm

estimate age-depth model from tracer
strat_to_time

transform objects from strat. to time domain
timetree

example time tree
tp_height_det

deterministic tie points height domain
sed_rate_from_matrix

make sed rate gen from matrix
sed_rate_t_fun

sedimentation rate function
sac_to_adm

turn sed. acc curve into adm
tp_to_sac

define sed. acc. curve
tp_time_floating_scale

tie points for floating time scale
sedrate_to_multiadm

Estimate age-depth model from sedimentation rates & tie points
strat_to_time.phylo

transform phylo object
summary.adm

summary of age-depth model
tp_time_det

deterministic tie points in time domain
CarboCATLite_data

Example data from CarboCATLite
T_axis_lab

plot time axis label
flux_const

constant deterministic tracer flux
add_adm_to_multiadm

add adm object ot multiadm object
flux_linear

linear deterministic tracer flux
admtools-package

admtools: Estimate and Manipulate Age-Depth Models
condensation

condensation with height