diff --git a/NEWS b/NEWS index b940b42bb..0d0b29998 100644 --- a/NEWS +++ b/NEWS @@ -14,6 +14,12 @@ Changes in version 0.4.4 (19th, May 2015): • Add support for ‘...’ argument for ‘calc_OSLLxTxRatio()’ arguments ‘background.count.distribution’ and ‘sigmab’. + • ‘Analyse_SAR.OSLdata()’ + + • Add support for ‘...’ argument for ‘calc_OSLLxTxRatio()’ + arguments ‘background.count.distribution’ and ‘sigmab’ + similar as done for the function ‘analyse_SAR.CWOSL()’. + • ‘calc_OSLLxTxRatio()’ • 'LxTx.Error' could become negative, which is not diff --git a/R/Analyse_SAR.OSLdata.R b/R/Analyse_SAR.OSLdata.R index d8759227e..0f1053bf1 100644 --- a/R/Analyse_SAR.OSLdata.R +++ b/R/Analyse_SAR.OSLdata.R @@ -69,6 +69,9 @@ #' #' @param cex.global \link{numeric} (with default): global scaling factor. #' +#' #' @param \dots further arguments that will be passed to the function +#' \code{\link{calc_OSLLxTxRatio}} (supported: \code{background.count.distribution} and \code{sigmab}) +#' #' @return A plot (optional) and \link{list} is returned containing the #' following elements: \item{LnLxTnTx}{\link{data.frame} of all calculated #' Lx/Tx values including signal, background counts and the dose points.} @@ -77,6 +80,8 @@ #' \item{SARParameters}{\link{data.frame} of additional measurement parameters #' obtained from the BIN file, e.g. preheat or read temperature (not valid for #' all types of measurements).} +#' +#' #' @note Rejection criteria are calculated but not considered during the #' analysis to discard values.\cr\cr #' @@ -86,7 +91,11 @@ #' #' \bold{The development of this function will not be continued. We recommend #' to use the function \link{analyse_SAR.CWOSL} or instead.} -#' @section Function version: 0.2.15 +#' +#' +#' @section Function version: 0.2.16 +#' +#' #' @author Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne #' (France), Margret C. Fuchs, TU Bergakademie Freiberg #' (Germany) @@ -137,7 +146,8 @@ Analyse_SAR.OSLdata <- function( log = "", output.plot = FALSE, output.plot.single = FALSE, - cex.global = 1 + cex.global = 1, + ... ){ ##============================================================================## @@ -174,6 +184,23 @@ Analyse_SAR.OSLdata <- function( "Dose", "Background")} + + # Deal with extra arguments ---------------------------------------------------- + + ##deal with addition arguments + extraArgs <- list(...) + + background.count.distribution <- + if ("background.count.distribution" %in% names(extraArgs)) { + extraArgs$background.count.distribution + } else + { + "non-poisson" + } + + sigmab <- if("sigmab" %in% names(extraArgs)) {extraArgs$sigmab} else + {NULL} + ##============================================================================## ##CALCULATIONS ##============================================================================## @@ -237,18 +264,33 @@ Analyse_SAR.OSLdata <- function( ##(3) calculate Lx/Tx ratios for(k in 1:length(LnLxTnTx.curves[1,])){ if(exists("LnLxTnTx")==FALSE){ - LnLxTnTx<-get_RLum.Results(calc_OSLLxTxRatio(as.data.frame(LnLxTnTx.curves[1,k]), - as.data.frame(LnLxTnTx.curves[2,k]), - signal.integral,background.integral)) + LnLxTnTx <- + get_RLum.Results( + calc_OSLLxTxRatio( + as.data.frame(LnLxTnTx.curves[1,k]), + as.data.frame(LnLxTnTx.curves[2,k]), + signal.integral,background.integral, + background.count.distribution = background.count.distribution, + sigmab = sigmab + ) + ) + }else{ - LnLxTnTx<-rbind(LnLxTnTx,get_RLum.Results(calc_OSLLxTxRatio(as.data.frame(LnLxTnTx.curves[1,k]), - as.data.frame(LnLxTnTx.curves[2,k]), - signal.integral,background.integral))) + LnLxTnTx <- + rbind(LnLxTnTx,get_RLum.Results( + calc_OSLLxTxRatio( + as.data.frame(LnLxTnTx.curves[1,k]), + as.data.frame(LnLxTnTx.curves[2,k]), + signal.integral,background.integral, + background.count.distribution = background.count.distribution, + sigmab = sigmab + ) + )) } } ##finally combine to data.frame including the record ID for further analysis - LnLxTnTx<-cbind(LnLxTnTx,LnLx.curveID,TnTx.curveID) + LnLxTnTx <- cbind(LnLxTnTx,LnLx.curveID,TnTx.curveID) ##(4.1) set info concerning the kind of regeneration points diff --git a/R/analyse_SAR.CWOSL.R b/R/analyse_SAR.CWOSL.R index 204f9912b..1f859b149 100644 --- a/R/analyse_SAR.CWOSL.R +++ b/R/analyse_SAR.CWOSL.R @@ -6,7 +6,9 @@ #' The function performs an analysis for a standard SAR protocol measurements #' introduced by Murray and Wintle (2000) with CW-OSL curves. For the #' calculation of the Lx/Tx value the function \link{calc_OSLLxTxRatio} is -#' used. \cr\cr +#' used. For \bold{changing the way the Lx/Tx error is calculated} use the argument +#' \code{background.count.distribution} and \code{sigmab}, which will be passed to the function +#' \link{calc_OSLLxTxRatio}.\cr\cr #' #' \bold{Working with IRSL data}\cr\cr #' @@ -287,7 +289,7 @@ object!") extraArgs$background.count.distribution } else { - "poisson" + "non-poisson" } sigmab <- if("sigmab" %in% names(extraArgs)) {extraArgs$sigmab} else diff --git a/R/calc_OSLLxTxRatio.R b/R/calc_OSLLxTxRatio.R index 4b0802d0f..c9ee3071c 100644 --- a/R/calc_OSLLxTxRatio.R +++ b/R/calc_OSLLxTxRatio.R @@ -21,6 +21,11 @@ #' \code{non-poisson}\cr \deqn{rse(\mu_{S}) \approx \sqrt(Y_{0} + Y_{1}/k^2 + #' \sigma^2(1+1/k))/Y_{0} - Y_{1}/k} #' +#' \bold{Please note that when using the early background subtraction method in combination with the +#' 'non-poisson' distribution argument, the corresponding Lx/Tx error may considerably increase due +#' to a high sigmab value. Please check whether this is valid for your data set and if necessary +#' consider to provide an own sigmab value using the corresponding argument \code{sigmab}.} +#' #' @param Lx.data \code{\linkS4class{RLum.Data.Curve}} or \link{data.frame} #' (\bold{required}): requires a CW-OSL shine down curve (x = time, y = counts) #' @@ -289,7 +294,7 @@ calc_OSLLxTxRatio <- function( ##(c.2) estimate relative standard error for a non-poisson distribution if(background.count.distribution != "non-poisson"){ - warning("Unknown value for background.count.distribution. A non-poisson distribution is assumed!")} + warning("Unknown method for background.count.distribution. A non-poisson distribution is assumed!")} LnLx.relError <- sqrt(Y.0 + Y.1/k^2 + sigmab.LnLx*(1+1/k))/ (Y.0 - Y.1/k) diff --git a/RLum.BuildResults/Luminescence-Ex.pdf b/RLum.BuildResults/Luminescence-Ex.pdf index 1ce65ee05..27575ecae 100644 Binary files a/RLum.BuildResults/Luminescence-Ex.pdf and b/RLum.BuildResults/Luminescence-Ex.pdf differ diff --git a/RLum.BuildResults/Luminescence-TimingExamples.0.4.4.pdf b/RLum.BuildResults/Luminescence-TimingExamples.0.4.4.pdf index 40f75ae6b..8c578623d 100644 Binary files a/RLum.BuildResults/Luminescence-TimingExamples.0.4.4.pdf and b/RLum.BuildResults/Luminescence-TimingExamples.0.4.4.pdf differ diff --git a/RLum.BuildResults/Luminescence-manual.pdf b/RLum.BuildResults/Luminescence-manual.pdf index ccedc87fd..4204a2578 100644 Binary files a/RLum.BuildResults/Luminescence-manual.pdf and b/RLum.BuildResults/Luminescence-manual.pdf differ diff --git a/RLum.BuildResults/Luminescence_0.4.4-Function_Arguments.csv b/RLum.BuildResults/Luminescence_0.4.4-Function_Arguments.csv index e0f47998a..67ddf575a 100644 --- a/RLum.BuildResults/Luminescence_0.4.4-Function_Arguments.csv +++ b/RLum.BuildResults/Luminescence_0.4.4-Function_Arguments.csv @@ -12,7 +12,7 @@ "slide.trend.corr",NA,"dots","output.plot",NA,NA,NA,NA,NA,NA,NA,NA,"plot",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"output.path","fit.trace",NA,NA,NA,NA,NA,NA,"summary.pos","par.local","output.plotExtended","dots","bw","legend.pos","dots",NA,NA,NA,"dots",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA "slide.show.density",NA,NA,"output.plot.single",NA,NA,NA,NA,NA,NA,NA,NA,"dots",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"output.terminal","fit.advanced",NA,NA,NA,NA,NA,NA,"legend","na.rm","output.plotExtended.single",NA,"output","stats",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA "plot",NA,NA,"cex.global",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"output.terminalAdvanced","fit.calcError",NA,NA,NA,NA,NA,NA,"legend.pos","dots","cex.global",NA,"dots","rug",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA -"xlab.unit",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"plot","bg.subtraction",NA,NA,NA,NA,NA,NA,"stats",NA,"dots",NA,NA,"plot.ratio",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA +"xlab.unit",NA,NA,"dots",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"plot","bg.subtraction",NA,NA,NA,NA,NA,NA,"stats",NA,"dots",NA,NA,"plot.ratio",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA "legend.pos",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"dots","output.path",NA,NA,NA,NA,NA,NA,"rug",NA,NA,NA,NA,"bar.col",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA "dots",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"output.terminal",NA,NA,NA,NA,NA,NA,"kde",NA,NA,NA,NA,"y.ticks",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,"output.terminaladvanced",NA,NA,NA,NA,NA,NA,"hist",NA,NA,NA,NA,"grid.col",NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA,NA diff --git a/RLum.BuildResults/Luminescence_0.4.4-Functions.csv b/RLum.BuildResults/Luminescence_0.4.4-Functions.csv index ba4b63e27..41aa83b24 100644 --- a/RLum.BuildResults/Luminescence_0.4.4-Functions.csv +++ b/RLum.BuildResults/Luminescence_0.4.4-Functions.csv @@ -3,9 +3,9 @@ ","
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France)
R Luminescence Package Team" "analyse_pIRIRSequence","Analyse post-IR IRSL sequences","
The function performs an analysis of post-IR IRSL sequences including curve
fitting on RLum.Analysis objects.
","0.1.4","2015-04-30","11:47:40 ","
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France)
R Luminescence Package Team" -"analyse_SAR.CWOSL","Analyse SAR CW-OSL measurements","
The function performs a SAR CW-OSL analysis on an
RLum.Analysis object including growth curve fitting.
","0.5.3","2015-05-10","15:12:52 +"analyse_SAR.CWOSL","Analyse SAR CW-OSL measurements","
The function performs a SAR CW-OSL analysis on an
RLum.Analysis object including growth curve fitting.
","0.5.3","2015-05-19","16:05:34 ","
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France)
R Luminescence Package Team" -"Analyse_SAR.OSLdata","Analyse SAR CW-OSL measurements.","
The function analyses SAR CW-OSL curve data and provides a summary of the
measured data for every position. The output of the function is optimised
for SAR OSL measurements on quartz.
","0.2.15","2015-05-10","15:12:52 +"Analyse_SAR.OSLdata","Analyse SAR CW-OSL measurements.","
The function analyses SAR CW-OSL curve data and provides a summary of the
measured data for every position. The output of the function is optimised
for SAR OSL measurements on quartz.
","0.2.16","2015-05-19","16:13:07 ","
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France), Margret C. Fuchs, TU Bergakademie Freiberg
(Germany)
R Luminescence Package Team" "analyse_SAR.TL","Analyse SAR TL measurements","
The function performs a SAR TL analysis on a
RLum.Analysis object including growth curve fitting.
","0.1.4","2015-04-30","11:49:25 ","
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne (France)
R Luminescence Package Team" @@ -36,7 +36,7 @@ ","
Christoph Burow, University of Cologne (Germany) Based on a
rewritten S script of Rex Galbraith, 2010
R Luminescence Package Team" "calc_MinDose","Apply the (un-)logged minimum age model (MAM) after Galbraith et al. (1999)
to a given De distribution","
Function to fit the (un-)logged three or four parameter minimum dose model
(MAM-3/4) to De data.
","0.4.1","2015-04-30","11:53:53 ","
Christoph Burow, University of Cologne (Germany) Based on a
rewritten S script of Rex Galbraith, 2010 The bootstrap approach is
based on a rewritten MATLAB script of Alastair Cunningham. Alastair
Cunningham is thanked for his help in implementing and cross-checking the
code.
R Luminescence Package Team" -"calc_OSLLxTxRatio","Calculate Lx/Tx ratio for CW-OSL curves","
Calculate Lx/Tx ratios from a given set of CW-OSL curves.
","0.5.1","2015-05-10","15:12:52 +"calc_OSLLxTxRatio","Calculate Lx/Tx ratio for CW-OSL curves","
Calculate Lx/Tx ratios from a given set of CW-OSL curves.
","0.5.1","2015-05-19","16:03:06 ","
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France)
R Luminescence Package Team" "calc_SourceDoseRate","Calculation of the source dose rate via the date of measurement","
Calculating the dose rate of the irradiation source via the date of
measurement based on: source calibration date, source dose rate, dose rate
error. The function returns a data.frame that provides the input argument
dose_rate for the function Second2Gray .
","0.1","2015-04-30","11:54:25 ","
Margret C. Fuchs, AWI Potsdam (Germany), Sebastian Kreutzer,
IRAMAT-CRP2A, Universite Bordeaux Montaigne (France)
R Luminescence Package Team" diff --git a/RLum.BuildResults/Luminescence_0.4.4-Functions.tex b/RLum.BuildResults/Luminescence_0.4.4-Functions.tex index 538892743..96e03ee7b 100644 --- a/RLum.BuildResults/Luminescence_0.4.4-Functions.tex +++ b/RLum.BuildResults/Luminescence_0.4.4-Functions.tex @@ -1,5 +1,5 @@ % latex table generated in R 3.3.0 by xtable 1.7-4 package -% Mon May 18 11:01:15 2015 +% Tue May 19 16:22:14 2015 \begin{table}[ht] \centering \begin{tabular}{rlllllll} @@ -10,9 +10,9 @@ & $<$br /$>$ Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne$<$br /$>$ (France)$<$br /$>$ R Luminescence Package Team \\ 2 & analyse\_pIRIRSequence & Analyse post-IR IRSL sequences & $<$br /$>$ The function performs an analysis of post-IR IRSL sequences including curve$<$br /$>$ fitting on RLum.Analysis objects.$<$br /$>$ & 0.1.4 & 2015-04-30 & 11:47:40 & $<$br /$>$ Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne$<$br /$>$ (France)$<$br /$>$ R Luminescence Package Team \\ - 3 & analyse\_SAR.CWOSL & Analyse SAR CW-OSL measurements & $<$br /$>$ The function performs a SAR CW-OSL analysis on an$<$br /$>$ RLum.Analysis object including growth curve fitting.$<$br /$>$ & 0.5.3 & 2015-05-10 & 15:12:52 + 3 & analyse\_SAR.CWOSL & Analyse SAR CW-OSL measurements & $<$br /$>$ The function performs a SAR CW-OSL analysis on an$<$br /$>$ RLum.Analysis object including growth curve fitting.$<$br /$>$ & 0.5.3 & 2015-05-19 & 16:05:34 & $<$br /$>$ Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne$<$br /$>$ (France)$<$br /$>$ R Luminescence Package Team \\ - 4 & Analyse\_SAR.OSLdata & Analyse SAR CW-OSL measurements. & $<$br /$>$ The function analyses SAR CW-OSL curve data and provides a summary of the$<$br /$>$ measured data for every position. The output of the function is optimised$<$br /$>$ for SAR OSL measurements on quartz.$<$br /$>$ & 0.2.15 & 2015-05-10 & 15:12:52 + 4 & Analyse\_SAR.OSLdata & Analyse SAR CW-OSL measurements. & $<$br /$>$ The function analyses SAR CW-OSL curve data and provides a summary of the$<$br /$>$ measured data for every position. The output of the function is optimised$<$br /$>$ for SAR OSL measurements on quartz.$<$br /$>$ & 0.2.16 & 2015-05-19 & 16:13:07 & $<$br /$>$ Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne$<$br /$>$ (France), Margret C. Fuchs, TU Bergakademie Freiberg$<$br /$>$ (Germany)$<$br /$>$ R Luminescence Package Team \\ 5 & analyse\_SAR.TL & Analyse SAR TL measurements & $<$br /$>$ The function performs a SAR TL analysis on a$<$br /$>$ RLum.Analysis object including growth curve fitting.$<$br /$>$ & 0.1.4 & 2015-04-30 & 11:49:25 & $<$br /$>$ Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne (France)$<$br /$>$ R Luminescence Package Team \\ @@ -43,7 +43,7 @@ & $<$br /$>$ Christoph Burow, University of Cologne (Germany) Based on a$<$br /$>$ rewritten S script of Rex Galbraith, 2010 $<$br /$>$ R Luminescence Package Team \\ 19 & calc\_MinDose & Apply the (un-)logged minimum age model (MAM) after Galbraith et al. (1999)$<$br /$>$ to a given De distribution & $<$br /$>$ Function to fit the (un-)logged three or four parameter minimum dose model$<$br /$>$ (MAM-3/4) to De data.$<$br /$>$ & 0.4.1 & 2015-04-30 & 11:53:53 & $<$br /$>$ Christoph Burow, University of Cologne (Germany) Based on a$<$br /$>$ rewritten S script of Rex Galbraith, 2010 The bootstrap approach is$<$br /$>$ based on a rewritten MATLAB script of Alastair Cunningham. Alastair$<$br /$>$ Cunningham is thanked for his help in implementing and cross-checking the$<$br /$>$ code.$<$br /$>$ R Luminescence Package Team \\ - 20 & calc\_OSLLxTxRatio & Calculate Lx/Tx ratio for CW-OSL curves & $<$br /$>$ Calculate Lx/Tx ratios from a given set of CW-OSL curves.$<$br /$>$ & 0.5.1 & 2015-05-10 & 15:12:52 + 20 & calc\_OSLLxTxRatio & Calculate Lx/Tx ratio for CW-OSL curves & $<$br /$>$ Calculate Lx/Tx ratios from a given set of CW-OSL curves.$<$br /$>$ & 0.5.1 & 2015-05-19 & 16:03:06 & $<$br /$>$ Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne$<$br /$>$ (France)$<$br /$>$ R Luminescence Package Team \\ 21 & calc\_SourceDoseRate & Calculation of the source dose rate via the date of measurement & $<$br /$>$ Calculating the dose rate of the irradiation source via the date of$<$br /$>$ measurement based on: source calibration date, source dose rate, dose rate$<$br /$>$ error. The function returns a data.frame that provides the input argument$<$br /$>$ dose\_rate for the function Second2Gray .$<$br /$>$ & 0.1 & 2015-04-30 & 11:54:25 & $<$br /$>$ Margret C. Fuchs, AWI Potsdam (Germany), Sebastian Kreutzer,$<$br /$>$ IRAMAT-CRP2A, Universite Bordeaux Montaigne (France)$<$br /$>$ R Luminescence Package Team \\ diff --git a/RLum.BuildScripts/Luminescence_0.4.4-Functions.html b/RLum.BuildScripts/Luminescence_0.4.4-Functions.html index 6f4082004..584b728a8 100644 --- a/RLum.BuildScripts/Luminescence_0.4.4-Functions.html +++ b/RLum.BuildScripts/Luminescence_0.4.4-Functions.html @@ -101,9 +101,9 @@

[version: 0.4.4 ]

0.5.3 -2015-05-10 +2015-05-19 -15:12:52 +16:05:34
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France)
R Luminescence Package Team @@ -118,11 +118,11 @@

[version: 0.4.4 ]


The function analyses SAR CW-OSL curve data and provides a summary of the
measured data for every position. The output of the function is optimised
for SAR OSL measurements on quartz.
-0.2.15 +0.2.16 -2015-05-10 +2015-05-19 -15:12:52 +16:13:07
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France), Margret C. Fuchs, TU Bergakademie Freiberg
(Germany)
R Luminescence Package Team @@ -423,9 +423,9 @@

[version: 0.4.4 ]

0.5.1 -2015-05-10 +2015-05-19 -15:12:52 +16:03:06
Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne
(France)
R Luminescence Package Team diff --git a/inst/NEWS.Rd b/inst/NEWS.Rd index 855cf0d49..3f2e0cc10 100644 --- a/inst/NEWS.Rd +++ b/inst/NEWS.Rd @@ -24,6 +24,14 @@ } + \item \code{Analyse_SAR.OSLdata()} + + \itemize{ + \item Add support for \code{...} argument for \code{calc_OSLLxTxRatio()} arguments + \code{background.count.distribution} and \code{sigmab} similar as done for the function \code{analyse_SAR.CWOSL()}. + + } + \item \code{calc_OSLLxTxRatio()} \itemize{ diff --git a/man/Analyse_SAR.OSLdata.Rd b/man/Analyse_SAR.OSLdata.Rd index 8cefc08a0..67e8bbf5e 100644 --- a/man/Analyse_SAR.OSLdata.Rd +++ b/man/Analyse_SAR.OSLdata.Rd @@ -7,7 +7,7 @@ Analyse_SAR.OSLdata(input.data, signal.integral, background.integral, position, run, set, dtype, keep.SEL = FALSE, info.measurement = "unkown measurement", log = "", output.plot = FALSE, - output.plot.single = FALSE, cex.global = 1) + output.plot.single = FALSE, cex.global = 1, ...) } \arguments{ \item{input.data}{\link{Risoe.BINfileData-class} (\bold{required}): input @@ -57,7 +57,12 @@ logarithmic and "xy" or "yx" if both axes are to be logarithmic. See (\code{TRUE/FALSE}) to allow for plotting the results in single plot windows. Requires \code{output.plot = TRUE}.} -\item{cex.global}{\link{numeric} (with default): global scaling factor.} +\item{cex.global}{\link{numeric} (with default): global scaling factor. + +#'} + +\item{\dots}{further arguments that will be passed to the function +\code{\link{calc_OSLLxTxRatio}} (supported: \code{background.count.distribution} and \code{sigmab})} } \value{ A plot (optional) and \link{list} is returned containing the @@ -103,7 +108,7 @@ consider using the functions \code{\link{analyse_SAR.CWOSL}} or to use the function \link{analyse_SAR.CWOSL} or instead.} } \section{Function version}{ - 0.2.15 (2015-05-10 15:12:52) + 0.2.16 (2015-05-19 16:13:07) } \examples{ ##load data diff --git a/man/Luminescence-package.Rd b/man/Luminescence-package.Rd index 843e5c841..57931d4cf 100644 --- a/man/Luminescence-package.Rd +++ b/man/Luminescence-package.Rd @@ -13,7 +13,7 @@ plotting of equivalent dose distributions. } \details{ \tabular{ll}{ Package: \tab Luminescence\cr Type: \tab Package\cr Version: -\tab 0.4.4 [upcoming]\cr Date: \tab 2015-05-XX\cr License: \tab GPL-3\cr } +\tab 0.4.4\cr Date: \tab 2015-05-19\cr License: \tab GPL-3\cr } } \author{ \bold{Authors} diff --git a/man/analyse_SAR.CWOSL.Rd b/man/analyse_SAR.CWOSL.Rd index 296298434..421b58011 100644 --- a/man/analyse_SAR.CWOSL.Rd +++ b/man/analyse_SAR.CWOSL.Rd @@ -73,7 +73,9 @@ The function performs a SAR CW-OSL analysis on an The function performs an analysis for a standard SAR protocol measurements introduced by Murray and Wintle (2000) with CW-OSL curves. For the calculation of the Lx/Tx value the function \link{calc_OSLLxTxRatio} is -used. \cr\cr +used. For \bold{changing the way the Lx/Tx error is calculated} use the argument +\code{background.count.distribution} and \code{sigmab}, which will be passed to the function +\link{calc_OSLLxTxRatio}.\cr\cr \bold{Working with IRSL data}\cr\cr @@ -109,7 +111,7 @@ This function must not be mixed up with the function \bold{The function currently does only support 'OSL' or 'IRSL' data!} } \section{Function version}{ - 0.5.3 (2015-05-10 15:12:52) + 0.5.3 (2015-05-19 16:05:34) } \examples{ ##load data diff --git a/man/calc_OSLLxTxRatio.Rd b/man/calc_OSLLxTxRatio.Rd index 8ba2fdc6d..896cbf82f 100644 --- a/man/calc_OSLLxTxRatio.Rd +++ b/man/calc_OSLLxTxRatio.Rd @@ -62,6 +62,11 @@ standard error is calculated as:\cr\cr (a) \code{poisson}\cr \deqn{rse(\mu_{S}) \approx \sqrt(Y_{0} + Y_{1}/k^2)/Y_{0} - Y_{1}/k} (b) \code{non-poisson}\cr \deqn{rse(\mu_{S}) \approx \sqrt(Y_{0} + Y_{1}/k^2 + \sigma^2(1+1/k))/Y_{0} - Y_{1}/k} + +\bold{Please note that when using the early background subtraction method in combination with the +'non-poisson' distribution argument, the corresponding Lx/Tx error may considerably increase due +to a high sigmab value. Please check whether this is valid for your data set and if necessary +consider to provide an own sigmab value using the corresponding argument \code{sigmab}.} } \note{ The results of this function have been cross-checked with the Analyst @@ -69,7 +74,7 @@ The results of this function have been cross-checked with the Analyst \code{\link{get_RLum.Results}}. } \section{Function version}{ - 0.5.1 (2015-05-10 15:12:52) + 0.5.1 (2015-05-19 16:03:06) } \examples{ ##load data