R Graphical Manual

Browse All

Last data update: 2014.03.03

R: Convert Risoe.BINfileData object to an RLum.Analysis object

Risoe.BINfileData2RLum.Analysis

R Documentation

Convert Risoe.BINfileData object to an RLum.Analysis object

Description

Converts values from one specific position of a Risoe.BINfileData S4-class object to an RLum.Analysis object.

Usage

Risoe.BINfileData2RLum.Analysis(object, pos = NULL, grain = NULL,
  run = NULL, set = NULL, ltype = NULL, dtype = NULL,
  protocol = "unknown", txtProgressBar = FALSE)

Arguments

`object`	`Risoe.BINfileData` (required): `Risoe.BINfileData` object
`pos`	`numeric` (optional): position number of the `Risoe.BINfileData` object for which the curves are stored in the `RLum.Analysis` object. If `length(position)>1` a list of `RLum.Analysis` objects is returned. If nothing is provided every position will be converted. If the position is not valid `NA` is returned.
`grain`	`vector, numeric` (optional): grain number from the measurement to limit the converted data set (e.g., `grain = c(1:48)`). Please be aware that this option may lead to unwanted effects, as the output is strictly limited to the choosen grain number for all position numbers
`run`	`vector, numeric` (optional): run number from the measurement to limit the converted data set (e.g., `run = c(1:48)`).
`set`	`vector, numeric` (optional): set number from the measurement to limit the converted data set (e.g., `set = c(1:48)`).
`ltype`	`vector, character` (optional): curve type to limit the converted data. Commonly allowed values are: `IRSL`, `OSL`, `TL`, `RIR`, `RBR` and `USER` (see also `Risoe.BINfileData`)
`dtype`	`vector, character` (optional): data type to limit the converted data. Commonly allowed values are listed in `Risoe.BINfileData`
`protocol`	`character` (optional): sets protocol type for analysis object. Value may be used by subsequent analysis functions.
`txtProgressBar`	logical (with default): enables or disables `txtProgressBar`.

Details

The RLum.Analysis object requires a set of curves for specific further protocol analyses. However, the Risoe.BINfileData usually contains a set of curves for different aliquots and different protocol types that may be mixed up. Therefore, a conversion is needed.

Value

Returns an RLum.Analysis object.

Function version

0.4.1 (2016-05-19 23:33:15)

Note

The protocol argument of the RLum.Analysis object is set to 'unknown' if not stated otherwise.

Author(s)

Sebastian Kreutzer, IRAMAT-CRP2A, Universite Bordeaux Montaigne (France)
R Luminescence Package Team

References

Examples


##load data
data(ExampleData.BINfileData, envir = environment())

##convert values for position 1
Risoe.BINfileData2RLum.Analysis(CWOSL.SAR.Data, pos = 1)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(Luminescence)
Welcome to the R package Luminescence version 0.6.0 [Built: 2016-05-30 16:47:30 UTC]
A tunnelling electron: 'God does not play dice.'
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/Luminescence/Risoe.BINfileData2RLum.Analysis.Rd_%03d_medium.png", width=480, height=480)
> ### Name: Risoe.BINfileData2RLum.Analysis
> ### Title: Convert Risoe.BINfileData object to an RLum.Analysis object
> ### Aliases: Risoe.BINfileData2RLum.Analysis
> ### Keywords: manip
> 
> ### ** Examples
> 
> 
> ##load data
> data(ExampleData.BINfileData, envir = environment())
> 
> ##convert values for position 1
> Risoe.BINfileData2RLum.Analysis(CWOSL.SAR.Data, pos = 1)
> 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>