Risoe.BINfileData-class: Class `"Risoe.BINfileData"`

Description

S4 class object for luminescence data in R. The object is produced as output of the function read_BIN2R.

Usage

# S4 method for Risoe.BINfileData
show(object)
# S4 method for ANY
set_Risoe.BINfileData(
  METADATA = data.frame(),
  DATA = list(),
  .RESERVED = list()
)
# S4 method for Risoe.BINfileData
get_Risoe.BINfileData(object, ...)
# S4 method for Risoe.BINfileData
add_metadata(object, info_element) <- value
# S4 method for Risoe.BINfileData
rename_metadata(object, info_element) <- value
# S4 method for Risoe.BINfileData
replace_metadata(object, info_element, subset = NULL) <- value
# S4 method for Risoe.BINfileData
sort_RLum(object, info_element, decreasing = FALSE, ...)
# S4 method for Risoe.BINfileData
view(object, ...)

Arguments

object: (required) an object of class Risoe.BINfileData
METADATA: Object of class "data.frame" containing the meta information for each curve.
DATA: Object of class "list" containing numeric vector with count data.
.RESERVED: Object of class "list" containing list of undocumented raw values for internal use only.
...: other arguments that might be passed
info_element: character (required): name of the metadata field to use in sorting.
value: (required) The value assigned to the selected elements of the metadata field. If NULL the elements named in info_element will be removed.
subset: expression (optional) logical expression to limit the substitution only to the selected subset of elements
decreasing: logical (with default): whether the sort order should be decreasing (FALSE by default).

Methods (by generic)

show(Risoe.BINfileData): Show structure of RLum and Risoe.BINfile class objects
set_Risoe.BINfileData(ANY): The Risoe.BINfileData is normally produced as output of the function read_BIN2R. This construction method is intended for internal usage only.
get_Risoe.BINfileData(Risoe.BINfileData): Formal get-method for Risoe.BINfileData object. It does not allow accessing the object directly, it is just showing a terminal message.
add_metadata(Risoe.BINfileData) <- value: Adds metadata to Risoe.BINfileData objects
rename_metadata(Risoe.BINfileData) <- value: Renames a metadata entry of Risoe.BINfileData objects
replace_metadata(Risoe.BINfileData) <- value: Replaces or removes metadata of Risoe.BINfileData objects
sort_RLum(Risoe.BINfileData): Sort method for Risoe.BINfileData objects
view(Risoe.BINfileData): View method for Risoe.BINfileData objects

Slots

METADATA: Object of class "data.frame" containing the meta information for each curve.

DATA

Object of class "list" containing numeric vector with count data.

.RESERVED

Object of class "list" containing list of undocumented raw values for internal use only.

Objects from the Class

Objects can be created by calls of the form new("Risoe.BINfileData", ...).

Function version

0.4.1

How to cite

Kreutzer, S., 2025. Risoe.BINfileData-class(): Class 'Risoe.BINfileData'. Function version 0.4.1. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J., Mercier, N., Philippe, A., Riedesel, S., Autzen, M., Mittelstrass, D., Gray, H.J., Galharret, J., Colombo, M., Steinbuch, L., Boer, A.d., 2025. Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 1.0.1. https://r-lum.github.io/Luminescence/

Author

Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany)
based on information provided by Torben Lapp and Karsten Bracht Nielsen (Risø DTU, Denmark) , RLum Developer Team

References

Risø DTU, 2013. The Sequence Editor User Manual - Feb 2013 and Risø DTU, 2016.

The Sequence Editor User Manual - February 2016

https://www.fysik.dtu.dk

Examples

Run this code


showClass("Risoe.BINfileData")

Run the code above in your browser using DataLab