Strips records from RLum-class objects

Remove records from an RLum-class object in a convenient way using get_RLum for the selection.

Usage

remove_RLum(object, ...)

# S4 method for class 'list'
remove_RLum(object, ...)

# S4 method for class 'RLum.Analysis'
remove_RLum(object, ...)

Arguments

object: RLum (required): object with records to be removed.
...: parameters to be passed to get_RLum. The arguments get.index and drop are preset and have no effect when provided

Value

An object of the same type as the input provided with records removed; it can result in an empty object.

Functions

remove_RLum(list): Returns a list of RLum objects where the selected records are stripped
remove_RLum(RLum.Analysis): Method to remove records from an RLum.Analysis object.

Function version

0.1.0

Author

Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany) , RLum Developer Team

How to cite

Kreutzer, S., 2025. remove_RLum(): Strips records from RLum-class objects. Function version 0.1.0. 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.1.1. https://r-lum.github.io/Luminescence/

Examples

## load example data
data(ExampleData.XSYG, envir = environment())
sar <- OSL.SARMeasurement$Sequence.Object[1:9]

## strop only OSL curves
sar <- remove_RLum(sar, recordType = "OSL")
sar
#> 
#>  [RLum.Analysis-class]
#> 	 originator: read_XSYG2R()
#> 	 protocol: SAR
#> 	 additional info elements:  0
#> 	 number of records: 4
#> 	 .. : RLum.Data.Curve : 4
#> 	 .. .. : #1 TL (UVVIS) <> #2 TL (NA) <> #3 TL (NA) 
#> 	 .. .. : #4 irradiation (NA)