Data

Tools

Indexes

Applications

Experiments

Open Source Science

rcarb

R package 'RCarb'

https://github.com/r-lum/rcarb

Science Score: 59.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 13 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    3 of 4 committers (75.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (19.4%) to scientific vocabulary

Keywords

dose-rate-modelling geochronology luminescence-dating r rpackage
Last synced: 6 months ago · JSON representation

Repository

R package 'RCarb'

Basic Info
Statistics
  • Stars: 2
  • Watchers: 5
  • Forks: 0
  • Open Issues: 0
  • Releases: 7
Topics
dose-rate-modelling geochronology luminescence-dating r rpackage
Created over 7 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Codemeta Zenodo

README.Rmd 

---
output: github_document
header-includes:
   - \usepackage{amsmath}
   - \usepackage{amssymb}
---


```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-"
)
library(RCarb)
```

# RCarb 

[![CRAN](https://www.r-pkg.org/badges/version/RCarb)](https://CRAN.R-project.org/package=RCarb)
[![CRAN DOI](https://img.shields.io/badge/doi-10.32614/CRAN.package.RCarb-blue.svg)](https://doi.org/10.32614/CRAN.package.RCarb)
[![DOI](https://zenodo.org/badge/151577249.svg)](https://zenodo.org/badge/latestdoi/151577249)
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/RCarb)](https://www.r-pkg.org/pkg/RCarb)
[![R-CMD-check](https://github.com/R-Lum/RCarb/workflows/GitHub Actions CI/badge.svg)](https://github.com/R-Lum/RCarb/actions)
[![codecov](https://app.codecov.io/gh/R-Lum/RCarb/graph/badge.svg?token=yAbeonoPiC)](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. [10.26034/la.atl.2019.533](https://doi.org/10.26034/la.atl.2019.533)

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. [10.26034/la.atl.2014.481](https://doi.org/10.26034/la.atl.2014.481)

**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

##  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).

* since 03/2023: Sebastian Kreutzer as maintainer of the package receives funding 
from the DFG Heisenberg programme No [505822867](https://gepris.dfg.de/gepris/projekt/505822867).

Owner

  • Name: RLum.Network
  • Login: R-Lum
  • Kind: organization
  • Email: developers@r-luminescence.org
  • Location: Europe

Enlightening the past and shaping the future

CodeMeta (codemeta.json) 

{
  "@context": [
    "https://doi.org/10.5063/schema/codemeta-2.0",
    "http://schema.org"
  ],
  "@type": "SoftwareSourceCode",
  "identifier": "RCarb",
  "description": "Translation of the 'MATLAB' program 'Carb' (Nathan and Mauz 2008 <DOI:10.1016/j.radmeas.2007.12.012>; Mauz and Hoffmann 2014) for dose rate modelling for carbonate-rich samples in the context of trapped charged dating (e.g., luminescence dating) applications. ",
  "name": "RCarb: Dose Rate Modelling of Carbonate-Rich Samples ",
  "codeRepository": "https://r-lum.github.io/RCarb/",
  "issueTracker": "https://github.com/R-Lum/RCarb/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.1.4.9000.6",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "version": "3.7.0",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R Under development (unstable) (2019-07-31 r76909)",
  "provider": {
    "@id": "https://cran.r-project.org",
    "@type": "Organization",
    "name": "Comprehensive R Archive Network (CRAN)",
    "url": "https://cran.r-project.org"
  },
  "author": [
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@u-bordeaux-montaigne.fr",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    },
    {
      "@type": "Person",
      "givenName": "Roger P.",
      "familyName": "Nathan"
    },
    {
      "@type": "Person",
      "givenName": "Barbara",
      "familyName": "Mauz",
      "@id": "https://orcid.org/0000-0003-1504-333X"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@u-bordeaux-montaigne.fr",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    },
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@u-bordeaux-montaigne.fr",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Roger P.",
      "familyName": "Nathan"
    },
    {
      "@type": "Person",
      "givenName": "Barbara",
      "familyName": "Mauz",
      "@id": "https://orcid.org/0000-0003-1504-333X"
    }
  ],
  "funder": {},
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@u-bordeaux-montaigne.fr",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 2.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "R.rsp",
      "name": "R.rsp",
      "version": ">= 0.43.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=R.rsp"
    }
  ],
  "softwareRequirements": [
    {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.4.0"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "interp",
      "name": "interp",
      "version": ">= 1.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=interp"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "matrixStats",
      "name": "matrixStats",
      "version": ">= 0.54.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=matrixStats"
    }
  ],
  "releaseNotes": "https://github.com/R-Lum/RCarb/blob/master/NEWS.md",
  "readme": "https://github.com/R-Lum/RCarb/blob/master/README.md",
  "contIntegration": [
    "https://travis-ci.org/R-Lum/RCarb",
    "https://ci.appveyor.com/project/RLumSK/rcarb",
    "https://codecov.io/gh/R-Lum/RCarb"
  ],
  "relatedLink": "https://CRAN.R-project.org/package=RCarb"
}

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 154
  • Total Committers: 4
  • Avg Commits per committer: 38.5
  • Development Distribution Score (DDS): 0.344
Past Year
  • Commits: 10
  • Committers: 2
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.1
Top Committers
Name Email Commits
RLumSK s****r@u****r 101
RLumSK s****r@a****k 41
RLumSK s****r@u****e 9
Sebastian Kreutzer R****K@u****m 3
Committer Domains (Top 20 + Academic)
uni-heidelberg.de: 1 aber.ac.uk: 1 u-bordeaux-montaigne.fr: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • cran 496 last-month
  • Total docker downloads: 22,375
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 3
    (may contain duplicates)
  • Total versions: 10
  • Total maintainers: 1
cran.r-project.org: RCarb

Dose Rate Modelling of Carbonate-Rich Samples

  • Versions: 6
  • Dependent Packages: 1
  • Dependent Repositories: 3
  • Downloads: 496 Last month
  • Docker Downloads: 22,375
Rankings
Docker downloads count: 0.6%
Dependent repos count: 16.4%
Dependent packages count: 18.1%
Average: 19.5%
Downloads: 26.4%
Forks count: 27.8%
Stargazers count: 27.8%
Maintainers (1)
sebastian.kreutzer@uni-heidelberg.de
Last synced: 6 months ago
conda-forge.org: r-rcarb
  • Versions: 4
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent packages count: 28.8%
Dependent repos count: 34.0%
Average: 46.0%
Stargazers count: 60.1%
Forks count: 61.1%
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 4.1 depends
  • utils * depends
  • interp >= 1.1 imports
  • matrixStats >= 0.62.0 imports
  • R.rsp >= 0.45.0 suggests
  • testthat >= 3.1.4 suggests
.github/workflows/GitHub_Actions_CI.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite