as_analyseBIN: Transfom SAR data sets into S3 class object "analyseBIN"

View source: R/as_analyseBIN.R

as_analyseBINR Documentation

Transfom SAR data sets into S3 class object "analyseBIN"

Description

Transfom SAR data sets into S3 class object "analyseBIN".

Usage

as_analyseBIN(SARdata)

Arguments

SARdata

matrix(required): SAR data set, it should contain five columns
(i.e., NO, SAR.Cycle, Dose, Signal, and Signal.Err), see SARdata for details

Value

Return an invisible list of S3 class object "analyseBIN" containing the following elements:

SARdata

a data.frame containing SAR data sets

criteria

values used as rejection criteria, here it is set equal to NULL

Tn

values of Tn and associated standard errors, here it is set equal to NULL

LnTn.curve

decay curves of Ln and Tn for different aliquots (grains), here it is set equal to NULL

TxTn

ratios of Tx to Tn for various SAR cycles, here it is set equal to NULL

agID

aliquot or grain ID (i.e., NO, Position, and Grain), here both Position and Grain are set equal to 0

SARdata is a data.frame containing the following elements:

Element Description
NO aliquot (grain) number
SAR.Cycle SAR cycle (N, R1, R2, R3, ...)
Dose regenerative dose
Signal OSL signal
Signal.Err standard error of OSL signal

Note

Function as_analyseBIN transforms SAR data sets (see SARdata) into S3 class object "analyseBIN". The returned elements such as criteria, Tn, LnTn.curve, and TxTn are set equal to NULL.

See Also

analyseBINdata; SARdata; calSARED; pickSARdata

Examples

  ### Example 1:
  data(SARdata)
  obj_analyseBIN <- as_analyseBIN(SARdata[1:8,,drop=FALSE])
  res_calSARED <- calSARED(obj_analyseBIN)
  res_calSARED$sarED

  ### Example 2 (not run):
  # obj_analyseBIN <- as_analyseBIN(SARdata)
  # res_calSARED <- calSARED(obj_analyseBIN, rcy1.range=c(1,1), outpdf="SARED")

  ### Example 3 (not run):
  # obj_analyseBIN <- as_analyseBIN(SARdata)
  # res_pickSARdata <- pickSARdata(obj_analyseBIN, fom.up=6, outpdf="SARdata")
  # res_pickSARdata$SARdata

numOSL documentation built on Sept. 18, 2023, 9:07 a.m.