Last data update: 2014.03.03

R: Plot function for an RLum.Analysis S4 class object
plot_RLum.AnalysisR Documentation

Plot function for an RLum.Analysis S4 class object

Description

The function provides a standardised plot output for curve data of an RLum.Analysis S4 class object

Usage

plot_RLum.Analysis(object, subset, nrows, ncols, abline = NULL,
  combine = FALSE, curve.transformation, plot.single = FALSE, ...)

Arguments

object

RLum.Analysis (required): S4 object of class RLum.Analysis

subset

named list (optional): subsets elements for plotting. The arguments in the named list will be directly passed to the function get_RLum (e.g., subset = list(curveType = "measured"))

nrows

integer (optional): sets number of rows for plot output, if nothing is set the function tries to find a value.

ncols

integer (optional): sets number of columns for plot output, if nothing is set the function tries to find a value.

abline

list (optional): allows to add ablines to the plot. Argument are provided in a list and will be forwared to the function abline, e.g., list(v = c(10, 100)) adds two vertical lines add 10 and 100 to all plots. In contrast list(v = c(10), v = c(100) adds a vertical at 10 to the first and a vertical line at 100 to the 2nd plot.

combine

logical (with default): allows to combine all RLum.Data.Curve objects in one single plot.

curve.transformation

character (optional): allows transforming CW-OSL and CW-IRSL curves to pseudo-LM curves via transformation functions. Allowed values are: CW2pLM, CW2pLMi, CW2pHMi and CW2pPMi. See details.

plot.single

logical (with default): global par settings are considered, normally this should end in one plot per page

...

further arguments and graphical parameters will be passed to the plot function. Supported arguments: main, mtext, log, lwd, lty type, pch, col, norm, xlim,ylim, xlab, ylab... and for combine = TRUE also: sub, legend, legend.text, legend.pos (typical plus 'outside'), legend.col, smooth. All arguments can be provided as vector or list to gain in full control of all plot settings.

Details

The function produces a multiple plot output. A file output is recommended (e.g., pdf).

curve.transformation

This argument allows transforming continuous wave (CW) curves to pseudo (linear) modulated curves. For the transformation, the functions of the package are used. Currently, it is not possible to pass further arguments to the transformation functions. The argument works only for ltype OSL and IRSL.

Please note: The curve transformation within this functions works roughly, i.e. every IRSL or OSL curve is transformed, without considerung whether it is measured with the PMT or not! However, for a fast look it might be helpful.

Value

Returns multiple plots.

Function version

0.3.6 (2016-05-02 09:41:37)

Note

Not all arguments available for plot will be passed! Only plotting of RLum.Data.Curve and RLum.Data.Spectrum objects are currently supported.

Author(s)

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

References

#

See Also

plot, plot_RLum, plot_RLum.Data.Curve

Examples


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

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

##plot (combine) TL curves in one plot
plot_RLum.Analysis(
temp,
subset = list(recordType = "TL"),
combine = TRUE,
norm = TRUE,
abline = list(v = c(110))
)

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]
The answer to life, the universe and everything: 'get_rightAnswer()'
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/Luminescence/plot_RLum.Analysis.Rd_%03d_medium.png", width=480, height=480)
> ### Name: plot_RLum.Analysis
> ### Title: Plot function for an RLum.Analysis S4 class object
> ### Aliases: plot_RLum.Analysis
> ### Keywords: aplot
> 
> ### ** Examples
> 
> 
> ##load data
> data(ExampleData.BINfileData, envir = environment())
> 
> ##convert values for position 1
> temp <- Risoe.BINfileData2RLum.Analysis(CWOSL.SAR.Data, pos=1)
> 
> ##plot (combine) TL curves in one plot
> plot_RLum.Analysis(
+ temp,
+ subset = list(recordType = "TL"),
+ combine = TRUE,
+ norm = TRUE,
+ abline = list(v = c(110))
+ )
> 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>