Skip to content
Dose Rate Estimation from In-Situ Gamma-Ray Spectrometry Measurements for Luminescence Dating
R
Branch: master
Clone or download
Latest commit 3479d1f Jun 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R Rename some files Jun 19, 2019
data-raw Fix value in Clermont dataset Jun 14, 2019
data Fix value in Clermont dataset Jun 14, 2019
inst Fix test, examples and documentation Jun 14, 2019
man Rename some files Jun 19, 2019
tests Test graphical output Jun 19, 2019
vignettes Fix value in Clermont dataset Jun 14, 2019
.Rbuildignore Add code metadata Jun 19, 2019
.gitignore Update ignored files list Jun 6, 2019
.travis.yml Update travis config Jun 19, 2019
.zenodo.json Fix typos Jun 6, 2019
CODE_OF_CONDUCT.md Add code of conduct Mar 28, 2019
DESCRIPTION
LICENSE.md Update LICENSE Apr 26, 2019
NAMESPACE Update DESCRIPTION and NAMESPACE Jun 13, 2019
NEWS.Rmd Change version number to 0.1.1.9000 Jun 7, 2019
NEWS.md Fix typo Jun 6, 2019
README.Rmd Update README Jun 19, 2019
README.md Update README Jun 19, 2019
_pkgdown.yml Fix pkgdown logo links Jun 6, 2019
appveyor.yml Update CI configs Jun 6, 2019
codecov.yml Set up Travis CI and Codecov Mar 31, 2019
codemeta.json Add code metadata Jun 19, 2019
gamma.Rproj Start package Mar 28, 2019

README.md

gamma

Appveyor build status Travis build Status codecov

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. lifecycle

DOI

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 files.

Installation

Install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("crp2a/gamma")

Usage

# See the package manual
utils::vignette("gamma", package = "gamma")
# A minimal example
# You may want to give extra attention to the energy calibration step
library(magrittr)

## Set the expected chanel/energy peaks for the energy scale calibration
calib_lines <- list(
  Pb212 = c(chanel = 86, energy = 238),
  K40 = c(chanel = 496, energy = 1461),
  Tl208 = c(chanel = 876, energy = 2615)
)

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

## Find the full path to the spectrum file
spectrum <- system.file("extdata/test_CNF.cnf", package = "gamma")

## Estimate the gamma dose rate
spectrum %>%
  gamma::read(skip = TRUE) %>%
  gamma::calibrate(lines = calib_lines) %>%
  gamma::predict(BDX1, ., simplify = TRUE)
#>             value    error
#> test_CNF 3920.904 130.9033

Contributing

Please note that the gamma project is released with a Contributor Code of Conduct. 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) throught the program Investissements d’avenir (ref. ANR-10-LABX-52).

You can’t perform that action at this time.