-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
80 lines (57 loc) · 3.85 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
---
output: github_document
header-includes:
- \usepackage{amsmath}
- \usepackage{amssymb}
---
<!-- README.md was auto-generated by README.Rmd. Please DO NOT edit by hand!-->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
library(RCarb)
```
# RCarb <img width=120px src="man/figures/Logo_RCarb.svg" align="right" />
[](https://CRAN.R-project.org/package=RCarb)
[](https://cranchecks.info/pkgs/RCarb)
[](https://zenodo.org/badge/latestdoi/151577249)
[](https://www.r-pkg.org/pkg/RCarb)
[](https://github.com/R-Lum/RCarb/actions)
[](https://app.codecov.io/gh/R-Lum/RCarb)
The **R** package `'RCarb'` provides a collection of various R functions to model dose rates in carbonate-rich samples. The package is a translation of the `'MATLAB'` program *Carb* by Roger P. Nathan.
## Installation of the developer version
To install the latest development builds of `'RCarb'` directly from GitHub, run
```r
if(!require("devtools"))
install.packages("devtools")
devtools::install_github("R-Lum/RCarb@master")
```
To install a developer build other than `'master'`, replace the term `'master'` in the code line by the name of the wanted developer build (not available yet).
Please further note that our 'GitHub' versions are developer versions and subject to daily changes. For stable please versions download the package from [CRAN](https://CRAN.R-project.org/package=RCarb).
## License
This program is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](https://github.com/R-Lum/RCarb/blob/master/LICENSE) for more details.
## Related projects
* [Luminescence](https://github.com/R-Lum/Luminescence)
* [RLumModel](https://github.com/R-Lum/RLumModel)
* [RLumCarlo](https://github.com/R-Lum/RLumCarlo)
* [RLumShiny](https://github.com/R-Lum/RLumShiny)
## References
Kreutzer, S., Mauz, B., Martin, L., Mercier, N., 2019. 'RCarb':
Dose Rate Modelling of Carbonate-Rich Samples - an Implementation of Carb in R -.
Ancient TL 37, 1–8. http://ancienttl.org/ATL_37-2_2019/ATL_37-2_Kreutzer_p1-8.pdf
Nathan, R.P., Mauz, B., 2008. On the dose-rate estimate of carbonate-rich sediments for trapped charge dating. Radiation Measurements 43, 14–25. doi: [10.1016/j.radmeas.2007.12.012](https://dx.doi.org/10.1016/j.radmeas.2007.12.012)
Mauz, B., Hoffmann, D., 2014. What to do when carbonate replaced water: Carb, the model for estimating the dose rate of carbonate-rich samples.
Ancient TL 32, 24–32. http://ancienttl.org/ATL_32-2_2014/ATL_32-2_Mauz_p24-32.pdf
**Further reading**
Nathan, R.P., 2010. Numerical modelling of environmental dose rate and its application to trapped-charge dating.
DPhil thesis, St Hugh’s College, Oxford. https://ora.ox.ac.uk/objects/ora:6421
## <span class="glyphicon glyphicon-euro"></span> Funding
* Between 2018-2019, the work of Sebastian Kreutzer as maintainer of the package was supported
by LabEx LaScArBxSK (ANR - n. ANR-10-LABX-52).
* Between 01/2020-04/2022, Sebastian Kreutzer received funding from the European Union’s Horizon 2020
research and innovation programme under the Marie Skłodowska-Curie grant agreement
No 844457 (project: CREDit).