Data

Tools

Indexes

Applications

Experiments

Open Source Science

gamma

Dose Rate Estimation from In-Situ Gamma-Ray Spectrometry Measurements

https://github.com/crp2a/gamma

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 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (20.0%) to scientific vocabulary

Keywords

archaeometry gamma-spectrometry geochronology luminescence-dating r-package
Last synced: 4 months ago · JSON representation

Repository

Dose Rate Estimation from In-Situ Gamma-Ray Spectrometry Measurements

Basic Info
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 2
  • Open Issues: 0
  • Releases: 10
Topics
archaeometry gamma-spectrometry geochronology luminescence-dating r-package
Created almost 7 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Codemeta Zenodo

README.Rmd 

---
output: github_document
---



```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = NULL
)
```

# gamma 


[![R-CMD-check](https://github.com/crp2a/gamma/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/crp2a/gamma/actions/workflows/R-CMD-check.yaml)
[![codecov](https://codecov.io/gh/crp2a/gamma/branch/master/graph/badge.svg)](https://app.codecov.io/gh/crp2a/gamma)

[![r-universe](https://crp2a.r-universe.dev/badges/gamma)](https://crp2a.r-universe.dev){.pkgdown-devel}
[![CRAN Version](https://www.r-pkg.org/badges/version/gamma)](https://cran.r-project.org/package=gamma){.pkgdown-release}
[![CRAN checks](https://badges.cranchecks.info/worst/gamma.svg)](https://cran.r-project.org/web/checks/check_results_gamma.html){.pkgdown-release}
[![CRAN Downloads](https://cranlogs.r-pkg.org/badges/gamma)](https://cran.r-project.org/package=gamma){.pkgdown-release}

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2652393.svg)](https://doi.org/10.5281/zenodo.2652393)

[![SWH](https://archive.softwareheritage.org/badge/swh:1:dir:459ecf47c4c0bb768732bd56c5c245ddab0d33f9/)](https://archive.softwareheritage.org/swh:1:dir:459ecf47c4c0bb768732bd56c5c245ddab0d33f9;origin=https://github.com/crp2a/gamma;visit=swh:1:snp:10e6be6e5cbe735b58c45abbcbabf20b93019e9c;anchor=swh:1:rev:1b3baf8821267ed656d780ae154d347769141d0c/)


## Overview

**gamma** is intended to process in-situ gamma-ray spectrometry measurements for luminescence dating. This package allows to import, inspect and (automatically) correct the energy scale of the spectrum. It provides methods for estimating the gamma dose rate by the use of a calibration curve. This package only supports Canberra CNF and TKA and Kromek SPE files.

The [**gammaShiny**](https://github.com/crp2a/gammaShiny) package provides an enhanced graphical user interface for the main applications of **gamma**.

```{r citation, echo=FALSE, comment=''}
cite <- utils::citation("gamma")
print(cite, bibtex = FALSE)
```

## Installation

You can install the released version of **gamma** from [CRAN](https://CRAN.R-project.org) with:

```{r cran-installation, eval=FALSE}
install.packages("gamma")
```

And the development version from [GitHub](https://github.com/) with:

```{r gh-installation, eval=FALSE}
# install.packages("remotes")
remotes::install_github("crp2a/gamma")
```

## Usage

```{r usage, fig.width=7, fig.height=3.5, fig.align='center'}
## A minimal example
library(gamma)

## Find the full path to the spectrum file
spc_file <- system.file("extdata/LaBr.CNF", package = "gamma")
## Import the spectrum
spectrum <- read(spc_file)

## Set the expected channel/energy peaks for the energy scale calibration
## Spectrum pre-processing and peak detection
peaks <- spectrum |>
  signal_slice() |>
  signal_stabilize(f = sqrt) |>
  signal_smooth(method = "savitzky", m = 21) |>
  signal_correct(method = "SNIP", n = 100) |>
  peaks_find()

## Set the energy values (in keV)
set_energy(peaks) <- c(238, NA, NA, NA, 1461, NA, NA, 2615)

## Calibrate the energy scale
calib <- energy_calibrate(spectrum, peaks)

## Inspect peaks
plot(calib, peaks)
```

```{r calib, fig.width=3.5, fig.height=3.5, fig.align='center'}
## Estimate the gamma dose rate of a set of spectra
## You may want to give extra attention to the energy calibration step
spc_file <- system.file("extdata/BDX_LaBr_1/test", package = "gamma")
spectra <- read(spc_file)

## Load the calibration curve for the dose rate estimation
## As this curve is instrument specific, you will have to build your own
data("BDX_LaBr_1", package = "gamma")
plot(BDX_LaBr_1)
```

```{r dose, eval=FALSE}
## Estimate the gamma dose rate
(doses <- dose_predict(BDX_LaBr_1, spectra))
```

```{r table, echo=FALSE}
doses <- dose_predict(BDX_LaBr_1, spectra)
knitr::kable(doses)
```

## Contributing

Please note that the **gamma** project is released with a [Contributor Code of Conduct](https://github.com/crp2a/gamma/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.

## Acknowledgements

This work received a state financial support managed by the Agence Nationale de la Recherche (France) through the program *Investissements d'avenir* (ref. 10-LABX-0052 and 11-IDEX-0001).

Owner

  • Name: Archéosciences Bordeaux
  • Login: crp2a
  • Kind: organization
  • Location: Pessac, France

Archaeological Science Laboratory at Bordeaux Montaigne University

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "gamma",
  "description": "Process in-situ Gamma-Ray Spectrometry for Luminescence Dating. This package allows to import, inspect and correct the energy shifts of gamma-ray spectra. It provides methods for estimating the gamma dose rate by the use of a calibration curve as described in Mercier and Falgures (2007). The package only supports Canberra CNF and TKA and Kromek SPE files.",
  "name": "gamma: Dose Rate Estimation from in-Situ Gamma-Ray Spectrometry\n    Measurements",
  "relatedLink": [
    "https://crp2a.github.io/gamma/",
    "https://CRAN.R-project.org/package=gamma"
  ],
  "codeRepository": "https://github.com/crp2a/gamma",
  "issueTracker": "https://github.com/crp2a/gamma/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "1.1.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.1 (2024-06-14)",
  "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": "Nicolas",
      "familyName": "Frerebeau",
      "email": "nicolas.frerebeau@u-bordeaux-montaigne.fr",
      "@id": "https://orcid.org/0000-0001-5759-4944"
    },
    {
      "@type": "Person",
      "givenName": "Brice",
      "familyName": "Lebrun",
      "email": "brice.lebrun@u-bordeaux-montaigne.fr",
      "@id": "https://orcid.org/0000-0001-7503-8685"
    },
    {
      "@type": "Person",
      "givenName": "Guilhem",
      "familyName": "Paradol",
      "email": "guilhem.paradol@cea.fr",
      "@id": "https://orcid.org/0000-0002-8561-4903"
    },
    {
      "@type": "Person",
      "givenName": "Sebastian",
      "familyName": "Kreutzer",
      "email": "sebastian.kreutzer@uni-heidelberg.de",
      "@id": "https://orcid.org/0000-0002-0734-2199"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Magali",
      "familyName": "Rizza",
      "email": "rizza@cerege.fr",
      "@id": "https://orcid.org/0000-0003-2364-5621"
    },
    {
      "@type": "Person",
      "givenName": "Christelle",
      "familyName": "Lahaye",
      "email": "christelle.lahaye@u-bordeaux-montaigne.fr",
      "@id": "https://orcid.org/0000-0003-2215-9015"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Organization",
      "name": "Universit Bordeaux Montaigne"
    }
  ],
  "funder": [
    {
      "@type": "Organization",
      "name": "Universit Bordeaux Montaigne"
    },
    {
      "@type": "Organization",
      "name": "CNRS"
    },
    {
      "@type": "Organization",
      "name": "LabEx Sciences archologiques de Bordeaux"
    },
    {
      "@type": "Organization",
      "name": "Idex Aix-Marseille"
    }
  ],
  "maintainer": [
    {
      "@type": "Organization",
      "name": "Archosciences Bordeaux",
      "email": "services-archeosciences@u-bordeaux-montaigne.fr"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "covr",
      "name": "covr",
      "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=covr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "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=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "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=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.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=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "vdiffr",
      "name": "vdiffr",
      "version": ">= 1.0.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=vdiffr"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.5"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "ggplot2",
      "name": "ggplot2",
      "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=ggplot2"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "graphics",
      "name": "graphics"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "IsoplotR",
      "name": "IsoplotR",
      "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=IsoplotR"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "rlang",
      "name": "rlang",
      "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=rlang"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "rxylib",
      "name": "rxylib",
      "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=rxylib"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "stats",
      "name": "stats"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "tools",
      "name": "tools"
    },
    "10": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils"
    },
    "SystemRequirements": null
  },
  "fileSize": "4261.603KB",
  "citation": [
    {
      "@type": "ScholarlyArticle",
      "datePublished": "2020",
      "author": [
        {
          "@type": "Person",
          "givenName": "Brice",
          "familyName": "Lebrun"
        },
        {
          "@type": "Person",
          "givenName": "Nicolas",
          "familyName": "Frerebeau"
        },
        {
          "@type": "Person",
          "givenName": "Guilhem",
          "familyName": "Paradol"
        },
        {
          "@type": "Person",
          "givenName": "Guillaume",
          "familyName": "Gurin"
        },
        {
          "@type": "Person",
          "givenName": "Norbert",
          "familyName": "Mercier"
        },
        {
          "@type": "Person",
          "givenName": "Chantal",
          "familyName": "Tribolo"
        },
        {
          "@type": "Person",
          "givenName": "Christelle",
          "familyName": "Lahaye"
        },
        {
          "@type": "Person",
          "givenName": "Magali",
          "familyName": "Rizza"
        }
      ],
      "name": "{gamma: An R Package for Dose Rate Estimation from In-Situ Gamma-Ray Spectrometry Measurements}",
      "pagination": "1-5",
      "isPartOf": {
        "@type": "PublicationIssue",
        "issueNumber": "2",
        "datePublished": "2020",
        "isPartOf": {
          "@type": [
            "PublicationVolume",
            "Periodical"
          ],
          "volumeNumber": "38",
          "name": "Ancient TL"
        }
      }
    },
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2024",
      "author": [
        {
          "@type": "Person",
          "givenName": "Nicolas",
          "familyName": "Frerebeau"
        },
        {
          "@type": "Person",
          "givenName": "Brice",
          "familyName": "Lebrun"
        },
        {
          "@type": "Person",
          "givenName": "Guilhem",
          "familyName": "Paradol"
        },
        {
          "@type": "Person",
          "givenName": "Sebastian",
          "familyName": "Kreutzer"
        }
      ],
      "name": "{gamma: Dose Rate Estimation from in-Situ Gamma-Ray Spectrometry}",
      "identifier": "10.5281/zenodo.2652393",
      "description": "R package version 1.1.0",
      "@id": "https://doi.org/10.5281/zenodo.2652393",
      "sameAs": "https://doi.org/10.5281/zenodo.2652393"
    }
  ],
  "releaseNotes": "https://github.com/crp2a/gamma/blob/master/NEWS.md",
  "readme": "https://github.com/crp2a/gamma/blob/master/README.md",
  "contIntegration": [
    "https://github.com/crp2a/gamma/actions/workflows/R-CMD-check.yaml",
    "https://app.codecov.io/gh/crp2a/gamma"
  ],
  "developmentStatus": "https://www.repostatus.org/#active",
  "keywords": [
    "luminescence-dating",
    "geochronology",
    "archaeology",
    "r-package",
    "gamma-spectrometry"
  ]
}

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
  • Pull request event: 1
Last Year
  • Watch event: 1
  • Push event: 1
  • Pull request event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 472
  • Total Committers: 5
  • Avg Commits per committer: 94.4
  • Development Distribution Score (DDS): 0.301
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
nfrerebeau 3****u 330
nfrerebeau n****u@u****r 120
blebrun b****n@i****m 18
blebrun 4****n 2
RLumSK s****r@u****e 2
Committer Domains (Top 20 + Academic)
uni-heidelberg.de: 1 u-bordeaux-montaigne.fr: 1

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 18
  • Total pull requests: 13
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 20 hours
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 0.39
  • Average comments per pull request: 0.62
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 10
  • Average time to close issues: 5 days
  • Average time to close pull requests: 1 day
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.5
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • blebrun (11)
  • nfrerebeau (5)
  • RLumSK (3)
  • Eiskeil (1)
Pull Request Authors
  • RLumSK (34)
  • pvermees (1)
  • blebrun (1)
Top Labels
Issue Labels
enhancement (12) bug (4) needs investigation (2) documentation (1) help wanted (1)
Pull Request Labels
enhancement (3)

Packages

  • Total packages: 1
  • Total downloads:
    • cran 206 last-month
  • Total docker downloads: 21,613
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 7
  • Total maintainers: 1
cran.r-project.org: gamma

Dose Rate Estimation from in-Situ Gamma-Ray Spectrometry Measurements

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 206 Last month
  • Docker Downloads: 21,613
Rankings
Stargazers count: 21.1%
Forks count: 21.9%
Dependent packages count: 29.8%
Average: 31.4%
Dependent repos count: 35.5%
Downloads: 48.8%
Maintainers (1)
services-archeosciences@u-bordeaux-montaigne.fr
Last synced: 4 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5 depends
  • IsoplotR * imports
  • ggplot2 * imports
  • graphics * imports
  • methods * imports
  • rlang * imports
  • rxylib * imports
  • stats * imports
  • tools * imports
  • utils * imports
  • covr * suggests
  • knitr * suggests
  • magrittr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests
  • vdiffr >= 1.0.0 suggests