"RLum.Analysis"
Object class to represent analysis data for protocol analysis, i.e. all curves, spectra etc. from one measurements. Objects from this class are produced, by e.g. read_XSYG2R, read_Daybreak2R
# S4 method for RLum.Analysis
show(object)# S4 method for RLum.Analysis
set_RLum(class, originator, .uid, .pid,
protocol = NA_character_, records = list(), info = list())
# S4 method for RLum.Analysis
get_RLum(object, record.id = NULL,
recordType = NULL, curveType = NULL, RLum.type = NULL,
protocol = "UNKNOWN", get.index = NULL, drop = TRUE,
recursive = TRUE, info.object = NULL, subset = NULL,
env = parent.frame(2))
# S4 method for RLum.Analysis
structure_RLum(object, fullExtent = FALSE)
# S4 method for RLum.Analysis
length_RLum(object)
# S4 method for RLum.Analysis
names_RLum(object)
# S4 method for RLum.Analysis
smooth_RLum(object, ...)
get_RLum
: names_RLum
, length_RLum
, structure_RLum
(required):
an object of class '>RLum.Analysis
get_RLum
: logical (with default):
if TRUE
(the default) and the result of the 'get_RLum' request is a single
object this object will be unlisted, means only the object itself and no
list containing exactly one object is returned. Mostly this makes things
easier, however, if this method is used within a loop this might be undesired.
get_RLum
: expression (optional):
logical expression indicating elements or rows to keep: missing values are
taken as false. This argument takes precedence over all other arguments,
meaning they are not considered when subsetting the object.
get_RLum
: environment (with default):
An environment passed to eval as the enclosure. This argument is only
relevant when subsetting the object and should not be used manually.
structure_RLum; logical (with default):
extents the returned data.frame
to its full extent, i.e. all info elements
are part of the return as well. The default value is FALSE
as the data
frame might become rather big.
further arguments passed to underlying methods
get_RLum
:
Returns:
list of '>RLum.Data objects or
Single '>RLum.Data object, if only one object is contained and recursive = FALSE
or
structure_RLum
:
Returns '>data.frame showing the structure.
length_RLum
Returns the number records in this object.
names_RLum
Returns the names of the record types (recordType
) in this object.
smooth_RLum
Same object as input, after smoothing
show
: Show structure of RLum.Analysis
object
get_RLum
: Accessor method for RLum.Analysis object.
The slots record.id, recordType, curveType and RLum.type are optional to allow for records limited by their id (list index number), their record type (e.g. recordType = "OSL") or object type.
Example: curve type (e.g. curveType = "predefined" or curveType ="measured")
The selection of a specific RLum.type object superimposes the default selection. Currently supported objects are: RLum.Data.Curve and RLum.Data.Spectrum
structure_RLum
: Method to show the structure of an '>RLum.Analysis object.
length_RLum
: Returns the length of the object, i.e., number of stored records.
names_RLum
: Returns the names of the '>RLum.Data objects objects (same as shown with the show method)
smooth_RLum
: Smoothing of RLum.Data
objects contained in this RLum.Analysis
object
zoo::rollmean or zoo::rollmedian. In particular the internal
function .smoothing
is used.
protocol
Object of class character describing the applied measurement protocol
records
Object of class list containing objects of class '>RLum.Data
Objects can be created by calls of the form set_RLum("RLum.Analysis", ...)
.
0.4.14
Kreutzer, S. (2018). RLum.Analysis-class(): Class 'RLum.Analysis'. In: Kreutzer, S., Burow, C., Dietze, M., Fuchs, M.C., Schmidt, C., Fischer, M., Friedrich, J. (2018). Luminescence: Comprehensive Luminescence Dating Data Analysis. R package version 0.8.6. https://CRAN.R-project.org/package=Luminescence
Risoe.BINfileData2RLum.Analysis, '>Risoe.BINfileData, '>RLum
# NOT RUN {
showClass("RLum.Analysis")
##set empty object
set_RLum(class = "RLum.Analysis")
###use example data
##load data
data(ExampleData.RLum.Analysis, envir = environment())
##show curves in object
get_RLum(IRSAR.RF.Data)
##show only the first object, but by keeping the object
get_RLum(IRSAR.RF.Data, record.id = 1, drop = FALSE)
# }
Run the code above in your browser using DataCamp Workspace