Luminescence (version 0.8.6)

use_DRAC: Use DRAC to calculate dose rate data

Description

The function provides an interface from R to DRAC. An R-object or a pre-formatted XLS/XLSX file is passed to the DRAC website and the results are re-imported into R.

Usage

use_DRAC(file, name, print_references = TRUE, citation_style = "text",
  ...)

Arguments

file

character (required): spreadsheet to be passed to the DRAC website for calculation. Can also be a DRAC template object obtained from template_DRAC().

name

character (with defautl): Optional user name submitted to DRAC. If omitted, a random name will be generated

print_references

(with default): Print all references used in the input data table to the console.

citation_style

(with default): If print_references = TRUE this argument determines the output style of the used references. Valid options are "Bibtex", "citation", "html", "latex" or "R". Default is "text".

...

Further arguments.

• url character: provide an alternative URL to DRAC

• verbose logical: show or hide console output

Value

Returns an '>RLum.Results object containing the following elements:

DRAC

list: a named list containing the following elements in slot @data:

$highlights	data.frame	summary of 25 most important input/output fields
$header	character	HTTP header from the DRAC server response
$labels	data.frame	descriptive headers of all input/output fields
$content	data.frame	complete DRAC input/output table
$input	data.frame	DRAC input table
$output	data.frame	DRAC output table
references	list	A list of bibentrys of used references

data

character or list path to the input spreadsheet or a DRAC template

call

call the function call

args

list used arguments

The output should be accessed using the function get_RLum.

Function version

0.1.3 (2018-02-19 16:53:17)

How to cite

Kreutzer, S., Dietze, M., Burow, C. (2018). use_DRAC(): Use DRAC to calculate dose rate data. Function version 0.1.3. 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

References

Durcan, J.A., King, G.E., Duller, G.A.T., 2015. DRAC: Dose Rate and Age Calculator for trapped charge dating. Quaternary Geochronology 28, 54-61. doi:10.1016/j.quageo.2015.03.012

Examples

# NOT RUN {
## (1) Method using the DRAC spreadsheet

file <-  "/PATH/TO/DRAC_Input_Template.csv"

# send the actual IO template spreadsheet to DRAC
# }
# NOT RUN {
use_DRAC(file = file)
# }
# NOT RUN {


## (2) Method using an R template object

# Create a template
input <- template_DRAC(preset = "DRAC-example_quartz")

# Fill the template with values
input$`Project ID` <- "DRAC-Example"
input$`Sample ID` <- "Quartz"
input$`Conversion factors` <- "AdamiecAitken1998"
input$`External U (ppm)` <- 3.4
input$`errExternal U (ppm)` <- 0.51
input$`External Th (ppm)` <- 14.47
input$`errExternal Th (ppm)` <- 1.69
input$`External K (%)` <- 1.2
input$`errExternal K (%)` <- 0.14
input$`Calculate external Rb from K conc?` <- "N"
input$`Calculate internal Rb from K conc?` <- "N"
input$`Scale gammadoserate at shallow depths?` <- "N"
input$`Grain size min (microns)` <- 90
input$`Grain size max (microns)` <- 125
input$`Water content ((wet weight - dry weight)/dry weight) %` <- 5
input$`errWater content %` <- 2
input$`Depth (m)` <- 2.2
input$`errDepth (m)` <- 0.22
input$`Overburden density (g cm-3)` <- 1.8
input$`errOverburden density (g cm-3)` <- 0.1
input$`Latitude (decimal degrees)` <- 30.0000
input$`Longitude (decimal degrees)` <- 70.0000
input$`Altitude (m)` <- 150
input$`De (Gy)` <- 20
input$`errDe (Gy)` <- 0.2

# use DRAC
# }
# NOT RUN {
output <- use_DRAC(input)
# }
# NOT RUN {
# }