plot_DetPlot: Create De(t) plot

Description Usage Arguments Details Value Function version How to cite Note Author(s) References See Also Examples

View source: R/plot_DetPlot.R

Description

Plots the equivalent dose (De) in dependency of the chosen signal integral (cf. Bailey et al., 2003). The function is simply passing several arguments to the function plot and the used analysis functions and runs it in a loop. Example: legend.pos for legend position, legend for legend text.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
plot_DetPlot(
  object,
  signal.integral.min,
  signal.integral.max,
  background.integral.min,
  background.integral.max,
  method = "shift",
  signal_integral.seq = NULL,
  analyse_function = "analyse_SAR.CWOSL",
  analyse_function.control = list(),
  n.channels = NULL,
  show_ShineDownCurve = TRUE,
  respect_RC.Status = FALSE,
  verbose = TRUE,
  ...
)

Arguments

object

RLum.Analysis (required): input object containing data for analysis

signal.integral.min

integer (required): lower bound of the signal integral.

signal.integral.max

integer (required): upper bound of the signal integral.

background.integral.min

integer (required): lower bound of the background integral.

background.integral.max

integer (required): upper bound of the background integral.

method

character (with default): method applied for constructing the De(t) plot.

  • shift (the default): the chosen signal integral is shifted the shine down curve,

  • expansion: the chosen signal integral is expanded each time by its length

signal_integral.seq

numeric (optional): argument to provide an own signal integral sequence for constructing the De(t) plot

analyse_function

character (with default): name of the analyse function to be called. Supported functions are: 'analyse_SAR.CWOSL', 'analyse_pIRIRSequence'

analyse_function.control

list (optional): selected arguments to be passed to the supported analyse functions ('analyse_SAR.CWOSL', 'analyse_pIRIRSequence')

n.channels

integer (optional): number of channels used for the De(t) plot. If nothing is provided all De-values are calculated and plotted until the start of the background integral.

show_ShineDownCurve

logical (with default): enables or disables shine down curve in the plot output

respect_RC.Status

logical (with default): remove De-values with 'FAILED' RC.Status from the plot (cf. analyse_SAR.CWOSL and analyse_pIRIRSequence)

verbose

logical (with default): enables or disables terminal feedback

...

further arguments and graphical parameters passed to plot.default, analyse_SAR.CWOSL and analyse_pIRIRSequence (see details for further information). Plot control parameters are: ylim, xlim, ylab, xlab, main, pch, mtext, cex, legend, legend.text, legend.pos

Details

method

The original method presented by Baiely et al., 2003 shifted the signal integrals and slightly extended them accounting for changes in the counting statistics. Example: c(1:3, 3:5, 5:7). However, here also another method is provided allowing to expand the signal integral by consectutively expaning the integral by its chosen length. Example: c(1:3, 1:5, 1:7)

Note that in both cases the integral limits are overlap. The finally applied limits are part of the function output.

analyse_function.control

The argument analyse_function.control currently supports the following arguments sequence.structure, dose.points, mtext.outer, fit.method, fit.force_through_origin, plot, plot.single

Value

A plot and an RLum.Results object with the produced De values

@data:

Object Type Description
De.values data.frame table with De values
signal_integral.seq numeric integral sequence used for the calculation

@info:

Object Type Description
call call the original function call

Function version

0.1.3

How to cite

Kreutzer, S., 2020. plot_DetPlot(): Create De(t) plot. Function version 0.1.3. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., 2020. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.9.7. https://CRAN.R-project.org/package=Luminescence

Note

The entire analysis is based on the used analysis functions, namely analyse_SAR.CWOSL and analyse_pIRIRSequence. However, the integrity checks of this function are not that thoughtful as in these functions itself. It means, that every sequence should be checked carefully before running long calculations using serveral hundreds of channels.

Author(s)

Sebastian Kreutzer, IRAMAT-CRP2A, UMR 5060, CNRS - Université Bordeaux Montaigne (France) , RLum Developer Team

References

Bailey, R.M., Singarayer, J.S., Ward, S., Stokes, S., 2003. Identification of partial resetting using De as a function of illumination time. Radiation Measurements 37, 511-518. doi:10.1016/S1350-4487(03)00063-5

See Also

plot, analyse_SAR.CWOSL, analyse_pIRIRSequence

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
## Not run: 
##load data
##ExampleData.BINfileData contains two BINfileData objects
##CWOSL.SAR.Data and TL.SAR.Data
data(ExampleData.BINfileData, envir = environment())

##transform the values from the first position in a RLum.Analysis object
object <- Risoe.BINfileData2RLum.Analysis(CWOSL.SAR.Data, pos=1)

plot_DetPlot(object,
             signal.integral.min = 1,
             signal.integral.max = 3,
             background.integral.min = 900,
             background.integral.max = 1000,
             n.channels = 5,
)

## End(Not run)

R-Lum/Luminescence documentation built on Jan. 4, 2020, 10:44 p.m.