use_DRAC: Use DRAC to calculate dose rate data

In R-Lum/Luminescence: Comprehensive Luminescence Dating Data Analysis

Use DRAC to calculate dose rate data

Description

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

Usage

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

Arguments

file	character (required): name of a CSV file (formatted according to the DRAC v1.2 CSV template) to be sent to the DRAC website for calculation. It can also be a DRAC template object obtained from template_DRAC().
name	character (with default): 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 ignore_version logical: ignores the version check, this might come in handy if the version has changed, but not the column order user character: option to provide username for secured site password character: password for secured site, only works jointly with user 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 bib entries 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.15

Author(s)

Sebastian Kreutzer, Institute of Geography, Heidelberg University (Germany)
Michael Dietze, GFZ Potsdam (Germany)
Christoph Burow, University of Cologne (Germany)

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

## (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)

## End(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)

## End(Not run)

R-Lum/Luminescence documentation built on March 1, 2025, 12:43 a.m.