create_input: Create input for age model

View source: R/utils-file.R

create_inputR Documentation

Create input for age model

Description

Create input for age models, based on the file structure and input files organisation needed.

Usage

create_input(data, wdir, entity = NULL, am = "bacon")

Arguments

data

List with named data frames containing the input data.

  • sample_depths: data frame with sampling depths information.

    • id: depth ID.

    • depth: depth in cm.

  • core: data frame with core (entity) information.

    • labID: lab ID.

    • age: age in years.

    • error: age uncertainty in years.

    • depth: depth in cm.

    • (Optional) cc: calibration curve.

      • cc = 1: IntCal20 (northern hemisphere terrestrial).

      • cc = 2: Marine20 (marine).

      • cc = 3: SHCal20 (southern hemisphere terrestrial).

  • (Optional) hiatus: data frame with information of hiatus depths, if not passed, then an empty file is created.

    • id: depth ID.

    • depth: depth in cm.

wdir

Working directory, absolute or relative path.

entity

Entity name.

am

Age model name.

Details

If only wdir is passed, the value of entity will be extracted from the last portion of wdir. For example, if wdir = "/path/to/a", then entity = "a" and wdir = "/path/to". If entity = NULL and wdir = "/" the function will return an error message, because the path is too short. To use the current working directory, wdir = "./".

Value

Input files for the age model.

Examples

test_data <-list(sample_depths = data.frame(id = 1:100,
                                            depth =
                                              seq(0, 500, length = 100)),
                 core = data.frame(labID = "RDG",
                                   age = c(720, 2700, 4660),
                                   error = c(70, 50, 110),
                                   depth = c(83, 212, 418)))
## Not run: 
ageR::create_input(test_data, getwd(), "Reading")

## End(Not run)

special-uor/ageR documentation built on July 10, 2024, 10:08 p.m.