# Comprehensive Luminescence Dating Data Analysis

## Documentation for package ‘Luminescence’ version 0.7.5

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D E F G H I L M N P R S T U V W misc

Luminescence-package | Comprehensive Luminescence Dating Data Analysis

## -- A --

analyse_baSAR | Bayesian models (baSAR) applied on luminescence data
analyse_FadingMeasurement | Analyse fading measurements and returns the fading rate per decade (g-value)
analyse_IRSAR.RF | Analyse IRSAR RF measurements
analyse_pIRIRSequence | Analyse post-IR IRSL sequences
analyse_portableOSL | Analyse portable CW-OSL measurements
analyse_SAR.CWOSL | Analyse SAR CW-OSL measurements
Analyse_SAR.OSLdata | Analyse SAR CW-OSL measurements.
analyse_SAR.TL | Analyse SAR TL measurements
apply_CosmicRayRemoval | Function to remove cosmic rays from an RLum.Data.Spectrum S4 class object
apply_EfficiencyCorrection | Function to apply spectral efficiency correction to RLum.Data.Spectrum S4 class objects
app_RLum | Run Luminescence shiny apps (wrapper)
as | as() - RLum-object coercion
as.data.frame.RLum.Data.Curve | methods_RLum
as.data.frame.RLum.Data.Spectrum | methods_RLum
as.list.RLum.Analysis | methods_RLum
as.list.RLum.Data.Curve | methods_RLum
as.list.RLum.Results | methods_RLum
as.matrix.RLum.Data.Curve | methods_RLum
as.matrix.RLum.Data.Spectrum | methods_RLum

## -- B --

BaseDataSet.CosmicDoseRate | Base data set for cosmic dose rate calculation
bin.RLum.Data.Curve | methods_RLum
bin_RLum.Data | Channel binning - method dispatchter
bin_RLum.Data-method | Class '"RLum.Data.Curve"'

## -- C --

calc_AliquotSize | Estimate the amount of grains on an aliquot
calc_AverageDose | Calculate the Average Dose and the dose rate dispersion
calc_CentralDose | Apply the central age model (CAM) after Galbraith et al. (1999) to a given De distribution
calc_CommonDose | Apply the (un-)logged common age model after Galbraith et al. (1999) to a given De distribution
calc_CosmicDoseRate | Calculate the cosmic dose rate
calc_FadingCorr | Apply a fading correction according to Huntley & Lamothe (2001) for a given g-value and a given tc
calc_FastRatio | Calculate the Fast Ratio for CW-OSL curves
calc_FiniteMixture | Apply the finite mixture model (FMM) after Galbraith (2005) to a given De distribution
calc_FuchsLang2001 | Apply the model after Fuchs & Lang (2001) to a given De distribution.
calc_gSGC | Calculate De value based on the gSGC by Li et al., 2015
calc_HomogeneityTest | Apply a simple homogeneity test after Galbraith (2003)
calc_IEU | Apply the internal-external-uncertainty (IEU) model after Thomsen et al. (2007) to a given De distribution
calc_Kars2008 | Apply the Kars et al. (2008) model
calc_MaxDose | Apply the maximum age model to a given De distribution
calc_MinDose | Apply the (un-)logged minimum age model (MAM) after Galbraith et al. (1999) to a given De distribution
calc_OSLLxTxRatio | Calculate Lx/Tx ratio for CW-OSL curves
calc_SourceDoseRate | Calculation of the source dose rate via the date of measurement
calc_Statistics | Function to calculate statistic measures
calc_ThermalLifetime | Calculates the Thermal Lifetime using the Arrhenius equation
calc_TLLxTxRatio | Calculate the Lx/Tx ratio for a given set of TL curves [beta version]
convert_BIN2CSV | Export Risoe BIN-file(s) to CSV-files
convert_Daybreak2CSV | Export measurement data produced by a Daybreak luminescence reader to CSV-files
convert_PSL2CSV | Export PSL-file(s) to CSV-files
convert_XSYG2CSV | Export XSYG-file(s) to CSV-files
CW2pHMi | Transform a CW-OSL curve into a pHM-OSL curve via interpolation under hyperbolic modulation conditions
CW2pLM | Transform a CW-OSL curve into a pLM-OSL curve
CW2pLMi | Transform a CW-OSL curve into a pLM-OSL curve via interpolation under linear modulation conditions
CW2pPMi | Transform a CW-OSL curve into a pPM-OSL curve via interpolation under parabolic modulation conditions

## -- D --

dim.RLum.Data.Curve | methods_RLum
dim.RLum.Data.Spectrum | methods_RLum

## -- E --

ExampleData.BINfileData | Example data from a SAR OSL and SAR TL measurement for the package Luminescence
ExampleData.CW_OSL_Curve | Example CW-OSL curve data for the package Luminescence
ExampleData.DeValues | Example De data sets for the package Luminescence
ExampleData.Fading | Example data for feldspar fading measurements
ExampleData.FittingLM | Example data for fit_LMCurve() in the package Luminescence
ExampleData.LxTxData | Example Lx/Tx data from CW-OSL SAR measurement
ExampleData.LxTxOSLData | Example Lx and Tx curve data from an artificial OSL measurement
ExampleData.portableOSL | Example portable OSL curve data for the package Luminescence
ExampleData.RLum.Analysis | Example data as 'RLum.Analysis' objects
ExampleData.RLum.Data.Image | Example data as 'RLum.Data.Image' objects
ExampleData.XSYG | Example data for a SAR OSL measurement and a TL spectrum using a lexsyg reader
extract_IrradiationTimes | Extract Irradiation Times from an XSYG-file

## -- F --

fit_CWCurve | Nonlinear Least Squares Fit for CW-OSL curves [beta version]
fit_LMCurve | Nonlinear Least Squares Fit for LM-OSL curves

## -- G --

get_Layout | Collection of layout definitions
get_Quote | Function to return essential quotes
get_rightAnswer | Function to get the right answer
get_Risoe.BINfileData | General accessor function for RLum S4 class objects
get_Risoe.BINfileData-method | Class '"Risoe.BINfileData"'
get_RLum | General accessor function for RLum S4 class objects
get_RLum-method | Class '"RLum.Analysis"'
get_RLum-method | Class '"RLum.Data.Curve"'
get_RLum-method | Class '"RLum.Data.Image"'
get_RLum-method | Class '"RLum.Data.Spectrum"'
get_RLum-method | Class '"RLum.Results"'
get_RLum-method | General accessor function for RLum S4 class objects
GitHub-API | GitHub API
github_branches | GitHub API
github_commits | GitHub API
github_issues | GitHub API

## -- H --

hist.RLum.Analysis | methods_RLum
hist.RLum.Data.Curve | methods_RLum
hist.RLum.Data.Image | methods_RLum
hist.RLum.Results | methods_RLum

## -- I --

install_DevelopmentVersion | Attempts to install the development version of the 'Luminescence' package
is.RLum | methods_RLum
is.RLum.Analysis | methods_RLum
is.RLum.Data | methods_RLum
is.RLum.Data.Curve | methods_RLum
is.RLum.Data.Image | methods_RLum
is.RLum.Data.Spectrum | methods_RLum
is.RLum.Results | methods_RLum

## -- L --

length.Risoe.BINfileData | methods_RLum
length.RLum.Analysis | methods_RLum
length.RLum.Data.Curve | methods_RLum
length.RLum.Results | methods_RLum
length_RLum | General accessor function for RLum S4 class objects
length_RLum-method | Class '"RLum.Analysis"'
length_RLum-method | Class '"RLum.Data.Curve"'
length_RLum-method | Class '"RLum.Results"'
Luminescence | Comprehensive Luminescence Dating Data Analysis

## -- M --

merge.RLum | methods_RLum
merge_Risoe.BINfileData | Merge Risoe.BINfileData objects or Risoe BIN-files
merge_RLum | General merge function for RLum S4 class objects
merge_RLum.Analysis | Merge function for RLum.Analysis S4 class objects
merge_RLum.Data.Curve | Merge function for RLum.Data.Curve S4 class objects
merge_RLum.Results | Merge function for RLum.Results S4-class objects
methods_RLum | methods_RLum
model_LuminescenceSignals | Model Luminescence Signals (wrapper)

## -- N --

names.Risoe.BINfileData | methods_RLum
names.RLum.Analysis | methods_RLum
names.RLum.Data.Curve | methods_RLum
names.RLum.Data.Image | methods_RLum
names.RLum.Data.Spectrum | methods_RLum
names.RLum.Results | methods_RLum
names_RLum | S4-names function for RLum S4 class objects
names_RLum-method | Class '"RLum.Analysis"'
names_RLum-method | Class '"RLum.Data.Curve"'
names_RLum-method | Class '"RLum.Data.Image"'
names_RLum-method | Class '"RLum.Data.Spectrum"'
names_RLum-method | Class '"RLum.Results"'

## -- P --

plot.list | methods_RLum
plot.Risoe.BINfileData | methods_RLum
plot.RLum.Analysis | methods_RLum
plot.RLum.Data.Curve | methods_RLum
plot.RLum.Data.Image | methods_RLum
plot.RLum.Data.Spectrum | methods_RLum
plot.RLum.Results | methods_RLum
plot_AbanicoPlot | Function to create an Abanico Plot.
plot_DetPlot | Create De(t) plot
plot_DRTResults | Visualise dose recovery test results
plot_FilterCombinations | Plot filter combinations along with the (optional) net transmission window
plot_GrowthCurve | Fit and plot a growth curve for luminescence data (Lx/Tx against dose)
plot_Histogram | Plot a histogram with separate error plot
plot_KDE | Plot kernel density estimate with statistics
plot_NRt | Visualise natural/regenerated signal ratios
plot_RadialPlot | Function to create a Radial Plot
plot_Risoe.BINfileData | Plot single luminescence curves from a BIN file object
plot_RLum | General plot function for RLum S4 class objects
plot_RLum.Analysis | Plot function for an RLum.Analysis S4 class object
plot_RLum.Data.Curve | Plot function for an RLum.Data.Curve S4 class object
plot_RLum.Data.Image | Plot function for an 'RLum.Data.Image' S4 class object
plot_RLum.Data.Spectrum | Plot function for an RLum.Data.Spectrum S4 class object
plot_RLum.Results | Plot function for an RLum.Results S4 class object
plot_ViolinPlot | Create a violin plot
PSL2Risoe.BINfileData | Convert portable OSL data to an Risoe.BINfileData object

## -- R --

read_BIN2R | Import Risoe BIN-file into R
read_Daybreak2R | Import measurement data produced by a Daybreak TL/OSL reader into R
read_PSL2R | Import PSL files to R
read_SPE2R | Import Princeton Intruments (TM) SPE-file into R
read_XSYG2R | Import XSYG files to R
rep.RLum | methods_RLum
replicate_RLum | General replication function for RLum S4 class objects
replicate_RLum-method | Class '"RLum"'
report_RLum | Create a HTML report for (RLum) objects
Risoe.BINfileData-class | Class '"Risoe.BINfileData"'
Risoe.BINfileData2RLum.Analysis | Convert Risoe.BINfileData object to an RLum.Analysis object
RLum-class | Class '"RLum"'
RLum.Analysis-class | Class '"RLum.Analysis"'
RLum.Data-class | Class '"RLum.Data"'
RLum.Data.Curve-class | Class '"RLum.Data.Curve"'
RLum.Data.Image-class | Class '"RLum.Data.Image"'
RLum.Data.Spectrum-class | Class '"RLum.Data.Spectrum"'
RLum.Results-class | Class '"RLum.Results"'
row.names.RLum.Data.Spectrum | methods_RLum

## -- S --

Second2Gray | Converting equivalent dose values from seconds (s) to gray (Gy)
set_Risoe.BINfileData | General accessor function for RLum S4 class objects
set_Risoe.BINfileData-method | Class '"Risoe.BINfileData"'
set_RLum | General set function for RLum S4 class objects
set_RLum-method | Class '"RLum.Analysis"'
set_RLum-method | Class '"RLum.Data.Curve"'
set_RLum-method | Class '"RLum.Data.Image"'
set_RLum-method | Class '"RLum.Data.Spectrum"'
set_RLum-method | Class '"RLum.Results"'
show-method | Class '"RLum.Analysis"'
show-method | Class '"RLum.Data.Curve"'
show-method | Class '"RLum.Data.Image"'
show-method | Class '"RLum.Data.Spectrum"'
show-method | Class '"RLum.Results"'
show-method | Class '"Risoe.BINfileData"'
smooth_RLum | Smoothing of data
smooth_RLum-method | Class '"RLum.Analysis"'
smooth_RLum-method | Class '"RLum.Data.Curve"'
smooth_RLum-method | Smoothing of data
sTeve | sTeve - sophisticated tool for efficient data validation and evaluation
structure_RLum | General structure function for RLum S4 class objects
structure_RLum-method | Class '"RLum.Analysis"'
subset.Risoe.BINfileData | methods_RLum
subset.RLum.Analysis | methods_RLum
summary.RLum.Analysis | methods_RLum
summary.RLum.Data.Curve | methods_RLum
summary.RLum.Data.Image | methods_RLum
summary.RLum.Results | methods_RLum

## -- T --

template_DRAC | Create a DRAC input data template (v1.1)
tune_Data | Tune data for experimental purpose

## -- U --

unlist.RLum.Analysis | methods_RLum
use_DRAC | Use DRAC to calculate dose rate data

## -- V --

verify_SingleGrainData | Verify single grain data sets and check for invalid grains, i.e. zero-light level grains

## -- W --

write_R2BIN | Export Risoe.BINfileData into Risoe BIN-file
write_RLum2CSV | Export RLum-objects to CSV

## -- misc --

$.RLum.Analysis | methods_RLum
$.RLum.Data.Curve | methods_RLum
$.RLum.Results | methods_RLum
*.RLum.Data.Curve | methods_RLum
+.RLum.Data.Curve | methods_RLum
-.RLum.Data.Curve | methods_RLum
/.RLum.Data.Curve | methods_RLum
[.RLum.Analysis | methods_RLum
[.RLum.Data.Curve | methods_RLum
[.RLum.Data.Image | methods_RLum
[.RLum.Data.Spectrum | methods_RLum
[.RLum.Results | methods_RLum
[<-.RLum.Data.Curve | methods_RLum
[[.RLum.Analysis | methods_RLum
[[.RLum.Results | methods_RLum