calSARED: SAR equivalent doses calculation and selection

Description Usage Arguments Value Note References See Also Examples

View source: R/calSARED.R

Description

Calculating and selecting a series of equivalent doses in a batch mode according to the single aliquot regenerative-dose (SAR) method (Murray and Wintle, 2000).

Usage

1
2
3
4
5
6
7
8
calSARED(obj_analyseBIN, model = "gok", origin = FALSE, 
         errMethod = "sp", nsim = 500, weight = TRUE, 
         trial = TRUE, nofit.rgd = NULL, Tn.above.3BG = TRUE, 
         TnBG.ratio.low = NULL, rseTn.up = NULL, FR.low = NULL, 
         rcy1.range = NULL, rcy2.range = NULL, rcy3.range = NULL, 
         rcp1.up = NULL, rcp2.up = NULL, fom.up = NULL, 
         rcs.up = NULL, calED.method = NULL, rseED.up = NULL, 
         use.se = TRUE, outpdf = NULL, outfile = NULL) 

Arguments

obj_analyseBIN

list(required): an object of S3 class "analyseBIN" produced by
function analyseBINdata or as_analyseBIN

model

character(with default): model used for growth curve fitting, see fitGrowth for available models

origin

logical(with default): logical value indicating if the growth curve should be forced to pass the origin

errMethod

character(with default): method used for equivalent dose error assessment. See function calED for details

nsim

integer(with default): desired number of randomly simulated equivalent dose obtained by Monte Carlo simulation

weight

logical(with default): logical value indicating if the growth curve should be fitted using a weighted procedure, see function fitGrowth for details

trial

logical(with default): logical value indicating if the growth curve should be fitted using other models if the given model fails, see function fitGrowth for details

nofit.rgd

integer(optional): regenerative doses that will not be used during the fitting. For example, if nofit.rgd=6 then the sixth regenerative dose will not be used during growth curve fitting

Tn.above.3BG

logical(with default): logical value indicating if aliquot (grain) with Tn below 3 sigma BG should be rejected

TnBG.ratio.low

numeric(optional): lower limit on ratio of initial Tn signal to BG

rseTn.up

numeric(optional): upper limit on relative standard error of Tn in percent

FR.low

numeric(optional): lower limit on fast ratio of Tn

rcy1.range

vector(optional): a two-element vector indicating the lower and upper limits on recycling ratio 1, Example: rcy1.range=c(0.9,1.1)

rcy2.range

vector(optional): a two-element vector indicating the lower and upper limits on recycling ratio 2

rcy3.range

vector(optional): a two-element vector indicating the lower and upper limits on recycling ratio 3

rcp1.up

numeric(optional): upper limit on recuperation 1 (i.e., ratio of the
sensitivity-corrected zero-dose signal to natural-dose signal) in percent

rcp2.up

numeric(optional): upper limit on recuperation 2 (i.e., ratio of the
sensitivity-corrected zero-dose signal to maximum regenerative-dose signal)
in percent

fom.up

numeric(optional): upper limit on figure of merit (FOM) values of growth curves in percent

rcs.up

numeric(optional): upper limit on reduced chi-square (RCS) values of growth curves

calED.method

character(optional): method used for equivalent dose calculation, i.e.,
"Interpolation" or "Extrapolation"

rseED.up

numeric(optional): upper limit on the relative standard error of equivalent dose in percent

use.se

logical(with default): logical value indicating if standard errors of values should be used during application of rejection criteria

outpdf

character(optional): if specified, results of SAR equivalent dose calculation will be written to a PDF file named "outpdf" and saved to the current work directory

outfile

character(optional): if specified, SAR equivalent doses related quantities will be written to a CSV file named "outfile" and saved to the current work directory

Value

Return an invisible list that contains the following elements:

LMpars

a list containing optimized parameters of growth curves of calculated (selected) SAR equivalent doses

Tn

values and standard errors of Tn of calculated (selected) SAR equivalent doses

Ltx

sensitivity-corrected natural-dose signals and associated standard errors used for SAR equivalent dose calculation

sarED

calculated (selected) SAR equivalent doses and associated standard errors

ConfInt

68 percent (one sigma) and 95 percent (two sigma) confidence intervals of SAR equivalent doses

agID

aliquot (grain) ID of calculated (selected) SAR equivalent doses

summary.info

a summary of the SAR equivalent dose calculation

Note

Rejection criteria used to select reliable SAR equivalent dose estimates can be catergorized into three groups:
(1) signal-related criteria, such as Tn.above.3BG, TnBG.ratio.low, rseTn.up, and FR.low;
(2) growth-curve-related criteria, such as rcy1.range, rcy2.range, rcy3.range, rcp1.up,
rcp2.up, fom.up, and rcs.up;
(3) equivalent-dose-related criteria, such as calED.method and rseED.up.

References

Duller GAT, 2016. Analyst (v4.31.9), User Mannual.

Murray AS, Wintle AG, 2000. Luminescence dating of quartz using improved single-aliquot regenerative-dose protocol. Radiation Measurements, 32(1): 57-73.

Wintle AG, Murray AS, 2006. A review of quartz optically stimulated luminescence characteristics and their relevance in single-aliquot regeneration dating protocols. Radiation Measurements, 41(4): 369-391.

See Also

analyseBINdata; fitGrowth;
calED; calSGCED; pickSARdata

Examples

1
2
3
4
5
6
  data(BIN)
  obj_pickBIN <- pickBINdata(BIN, Position=c(2,4,6,8,10), Grain=0, 
                             LType="OSL", view=FALSE)
  obj_analyseBIN <- analyseBINdata(obj_pickBIN, nfchn=3, nlchn=20) 
  res_SARED <- calSARED(obj_analyseBIN, model="exp", origin=FALSE)
  # plot(res_SARED$Tn[,1], res_SARED$sarED[,1], xlab="Tn", ylab="ED (<Gy>|<s>)")

numOSL documentation built on May 1, 2019, 8:45 p.m.