methods_RLum

0th

Percentile

methods_RLum

Methods for S3-generics implemented for the package 'Luminescence'. This document summarises all implemented S3-generics. The name of the function is given before the first dot, after the dot the name of the object that is supported by this method is given, e.g. plot.RLum.Data.Curve can be called by plot(object, ...), where object is the RLum.Data.Curve object.

Keywords
internal
Usage
# S3 method for list
plot(x, y, ...)

# S3 method for RLum.Results plot(x, y, ...)

# S3 method for RLum.Analysis plot(x, y, ...)

# S3 method for RLum.Data.Curve plot(x, y, ...)

# S3 method for RLum.Data.Spectrum plot(x, y, ...)

# S3 method for RLum.Data.Image plot(x, y, ...)

# S3 method for Risoe.BINfileData plot(x, y, ...)

# S3 method for RLum.Results hist(x, ...)

# S3 method for RLum.Data.Image hist(x, ...)

# S3 method for RLum.Data.Curve hist(x, ...)

# S3 method for RLum.Analysis hist(x, ...)

# S3 method for RLum.Results summary(object, ...)

# S3 method for RLum.Analysis summary(object, ...)

# S3 method for RLum.Data.Image summary(object, ...)

# S3 method for RLum.Data.Curve summary(object, ...)

# S3 method for Risoe.BINfileData subset(x, subset, records.rm = TRUE, ...)

# S3 method for RLum.Analysis subset(x, subset = NULL, ...)

bin.RLum.Data.Curve(x, bin_size = 2, ...)

# S3 method for RLum.Results length(x, ...)

# S3 method for RLum.Analysis length(x, ...)

# S3 method for RLum.Data.Curve length(x, ...)

# S3 method for Risoe.BINfileData length(x, ...)

# S3 method for RLum.Data.Curve dim(x)

# S3 method for RLum.Data.Spectrum dim(x)

# S3 method for RLum rep(x, ...)

# S3 method for RLum.Data.Curve names(x, ...)

# S3 method for RLum.Data.Spectrum names(x, ...)

# S3 method for RLum.Data.Image names(x, ...)

# S3 method for RLum.Analysis names(x, ...)

# S3 method for RLum.Results names(x, ...)

# S3 method for Risoe.BINfileData names(x)

# S3 method for RLum.Data.Spectrum row.names(x, ...)

# S3 method for RLum.Data.Curve as.data.frame(x, row.names = NULL, optional = FALSE, ...)

# S3 method for RLum.Data.Spectrum as.data.frame(x, row.names = NULL, optional = FALSE, ...)

# S3 method for RLum.Results as.list(x, ...)

# S3 method for RLum.Data.Curve as.list(x, ...)

# S3 method for RLum.Analysis as.list(x, ...)

# S3 method for RLum.Data.Curve as.matrix(x, ...)

# S3 method for RLum.Data.Spectrum as.matrix(x, ...)

is.RLum(x, ...)

is.RLum.Data(x, ...)

is.RLum.Data.Curve(x, ...)

is.RLum.Data.Spectrum(x, ...)

is.RLum.Data.Image(x, ...)

is.RLum.Analysis(x, ...)

is.RLum.Results(x, ...)

# S3 method for RLum merge(x, y, ...)

# S3 method for RLum.Analysis unlist(x, recursive = TRUE, ...)

# S3 method for RLum.Data.Curve +(x, y)

# S3 method for RLum.Data.Curve -(x, y)

# S3 method for RLum.Data.Curve *(x, y)

# S3 method for RLum.Data.Curve /(x, y)

# S3 method for RLum.Data.Curve [(x, y, z, drop = TRUE)

# S3 method for RLum.Data.Spectrum [(x, y, z, drop = TRUE)

# S3 method for RLum.Data.Image [(x, y, z, drop = TRUE)

# S3 method for RLum.Analysis [(x, i, drop = FALSE)

# S3 method for RLum.Results [(x, i, drop = TRUE)

# S3 method for RLum.Data.Curve [(x, i, j) <- value

# S3 method for RLum.Analysis [[(x, i)

# S3 method for RLum.Results [[(x, i)

# S3 method for RLum.Data.Curve $(x, i)

# S3 method for RLum.Analysis $(x, i)

# S3 method for RLum.Results $(x, i)

Arguments
x

'>RLum or '>Risoe.BINfileData (required): input opject

y

integer (optional): the row index of the matrix, data.frame

...

further arguments that can be passed to the method

object

'>RLum (required): input opject

subset

[subset] expression (required): logical expression indicating elements or rows to keep, this function works in '>Risoe.BINfileData objects like subset.data.frame, but takes care of the object structure

records.rm

subset logical (with default): remove records from data set, can be disabled, to just set the column SET to TRUE or FALSE

row.names

logical (with default): enables or disables row names (as.data.frame)

optional

logical (with default): logical. If TRUE, setting row names and converting column names (to syntactic names: see make.names) is optional (see base::as.data.frame)

recursive

logical (with default): enables or disables further subsetting (unlist)

z

integer (optional): the column index of the matrix, data.frame

drop

logical (with default): keep object structure or drop it

i

character (optional): name of the wanted record type or data object or row in the RLum.Data.Curve object

j

integer (optional): column of the data matrix in the RLum.Data.Curve object

value

numeric (required): numeric value which replace the value in the RLum.Data.Curve object

Details

The term S3-generics sounds complicated, however, it just means that something has been implemented in the package to increase the usability for users new in R and who are not familiar with the underlying RLum-object structure of the package. The practical outcome is that operations and functions presented in standard books on R can be used without knowing the specifica of the R package 'Luminescence'. For examples see the example section.

Note

methods_RLum are not really new functions, everything given here are mostly just surrogates for existing functions in the package.

Aliases
  • methods_RLum
  • plot.list
  • plot.RLum.Results
  • plot.RLum.Analysis
  • plot.RLum.Data.Curve
  • plot.RLum.Data.Spectrum
  • plot.RLum.Data.Image
  • plot.Risoe.BINfileData
  • hist.RLum.Results
  • hist.RLum.Data.Image
  • hist.RLum.Data.Curve
  • hist.RLum.Analysis
  • summary.RLum.Results
  • summary.RLum.Analysis
  • summary.RLum.Data.Image
  • summary.RLum.Data.Curve
  • subset.Risoe.BINfileData
  • subset.RLum.Analysis
  • bin.RLum.Data.Curve
  • length.RLum.Results
  • length.RLum.Analysis
  • length.RLum.Data.Curve
  • length.Risoe.BINfileData
  • dim.RLum.Data.Curve
  • dim.RLum.Data.Spectrum
  • rep.RLum
  • names.RLum.Data.Curve
  • names.RLum.Data.Spectrum
  • names.RLum.Data.Image
  • names.RLum.Analysis
  • names.RLum.Results
  • names.Risoe.BINfileData
  • row.names.RLum.Data.Spectrum
  • as.data.frame.RLum.Data.Curve
  • as.data.frame.RLum.Data.Spectrum
  • as.list.RLum.Results
  • as.list.RLum.Data.Curve
  • as.list.RLum.Analysis
  • as.matrix.RLum.Data.Curve
  • as.matrix.RLum.Data.Spectrum
  • is.RLum
  • is.RLum.Data
  • is.RLum.Data.Curve
  • is.RLum.Data.Spectrum
  • is.RLum.Data.Image
  • is.RLum.Analysis
  • is.RLum.Results
  • merge.RLum
  • unlist.RLum.Analysis
  • +.RLum.Data.Curve
  • -.RLum.Data.Curve
  • *.RLum.Data.Curve
  • /.RLum.Data.Curve
  • [.RLum.Data.Curve
  • [.RLum.Data.Spectrum
  • [.RLum.Data.Image
  • [.RLum.Analysis
  • [.RLum.Results
  • [<-.RLum.Data.Curve
  • [[.RLum.Analysis
  • [[.RLum.Results
  • $.RLum.Data.Curve
  • $.RLum.Analysis
  • $.RLum.Results
Examples
# NOT RUN {
##load example data
data(ExampleData.RLum.Analysis, envir = environment())


##combine curve is various ways
curve1 <- IRSAR.RF.Data[[1]]
curve2 <-  IRSAR.RF.Data[[1]]
curve1 + curve2
curve1 - curve2
curve1 / curve2
curve1 * curve2


##`$` access curves
IRSAR.RF.Data$RF

# }
Documentation reproduced from package Luminescence, version 0.8.6, License: GPL-3

Community examples

Looks like there are no examples yet.