Changelog
Source:NEWS.md
gamma 1.1.0
CRAN release: 2024-09-23
Bugfixes
- Fix an error in the uncertainty calculation of
dose_predict()
. The returned error was too large and did not make much sense due to an internal calculation error. Along with the fix, the manual was updated to detail the uncertainty calculation. (PR #42 by @RLumSK) - Fix a graphical issue where the peaks were peaks were set with
set_energy()
but did not show correctly when plotted using the standard plot method, e.g.,plot(cal, pks)
would show only observed but not expected energy lines in the secondary x-axis. Now the expected energy lines (if set) are show. (#29, PR #32 by @RLumSK). - Fix the uncertainty calculation for the integrated signal. The formula had an factor of 2 in
var(2 * x)
wherex
is the integrated signal. Now the formula considers plain Poisson statistics. Along with this change, the calculation is now detailed in the manual (PR #46 by @RLumSK).
Additions
- Add support for Kromek SPE files to
read()
(#28 by @RLumSK). - Add support for
GammaSpectra-class
objects forenergy_calibrate()
(issue: #22, PR #31 by @RLumSK). - Add coercion method for
PeakPosition-class
tolist
(exported asas.list()
) and fromlist
toPeakPosition-class
. This enables better plotting functionality if the peak positions for where provided manually aslist
and not via, e.g.,peak_find()
(PR #37 by @RLumSK). - Add additional columns to the output object of
dose_predict()
and calculate a “final” dose based on the mean of the findings from the count and the energy threshold (PR #43 by @RLumSK) - Add new methods for signatures
lm
,CalibrationCurve-class
, andGammaSpectrum-class
toenergy_calibrate()
forGammaSpectrum-class
andGammaSpectra-class()
objects for the argumentlines
. In simple words, instead of providing data for an energy/channel calibration such calibration can be copied over from another already calibrated spectrum (PR #49, #52 by @RLumSK). - Add support for the energy calibration model to
dose_fit()
anddose_predict()
. What does it mean? (1) If an energy calibration was performed on the spectra used for the dose rate model fitting, the model information is forwarded to the info slot of the model. (2) The functiondose_fit()
can read this information and double-check whether the user tries to predict the dose with calibrated or uncalibrated data. If the calibration has data but the spectrum does not, the function tries to use the available calibration. Given that the energy calibration often does not change considerably, this should dramatically simplify the workflow once the equipment was calibrated (PR #49 by @RLumSK). - Add new argument
use_MC
todose_predict()
method. The default isFALSE
to maintain compatibility with old code and output exceptions. If set toTRUE
the uncertainty on the gamma dose rate uses a Monte Carlo simulation approach for a more realistic error estimation (PR #46 by RLumSK) - Add new function parameter
water_content
todose_predict()
to allow for an estimate of the dry gamma dose rate using the correction factor by Aitken (1985). The default isNULL
, in this case nothing is corrected (PR #48 by @RLumSK) - Add two more generics:
set_energy_calibration()
andget_energy_calibration()
and corresponding methods forGammaSpectrum
andGammaSpectra
objects. They build onenergy_calibrate()
but enable a more comprehensible scripting (PR XX by RLumSK). - Extend
dose_predict()
to work with anumeric
input forbackground
as claimed in the documentary. This value can also be set toc(0,0)
if no background subtraction is wanted (PR #38 by @RLumSK)
Changes
- Update vignette about the dose rate calibration curve determination to make it more intelligible (#30 by @RLumSK).
- Update manual for the output object of
dose_predict()
, which had some loopholes (PR #43 by @RLumSK)
gamma 1.0.3
CRAN release: 2022-09-15
Bugfixes & changes
- Remove the
alpha
argument indose_fit()
to follow changes in IsoplotR.
gamma 1.0.2
CRAN release: 2022-08-23
Internals
- Use testthat 3rd edition (#20).
- Change package maintainer (#24).
- The package was removed from CRAN due to an internal call to a defunct function
default.stringsAsFactors()
; fixed (#23, @RLumSK)
gamma 1.0.1
CRAN release: 2021-01-13
Internals
- Skip test if suggested packages are not installed (#19).
- Use
\doi
instead of\href
in documentation.