shoredate (version 1.1.1)

sum_shoredates: Sum the probability of multiple shoreline dates

Description

Function for finding the summed probability distribution of multiple shoreline dates.

Usage

sum_shoredates(
  shoreline_dates,
  cut_off = -2500,
  cut_off_level = 1,
  normalise = TRUE
)

Value

List of class shoredate_sum holding the elements:

• sum data frame with the columns bce where negative values indicate years BCE and positive CE, as well as probability, which gives the probability mass for each year.

• dates_n number of dates that make up the sum after applying any specified cut-off. One date per site per isobase direction.

Arguments

shoreline_dates

Object of class shoreline_date.

cut_off

Calendar year specifying where dates should be cut off. Defaults to 2500 BCE.

cut_off_level

Numerical value between 0 and 1 indicating the probability mass that has to fall after the cut-off for a date to be excluded. Defaults to 1, retaining all dates.

normalise

Logical value indicating whether the probability sum of the dates should be normalised to sum to unity. Defaults to TRUE.

Examples

target_points <- sf::st_sfc(sf::st_point(c(538310, 6544255)),
                            sf::st_point(c(538300, 6544250)))
target_points <- sf::st_as_sf(target_points, crs = 32632)

# Shoreline date, reducing resoltuion on elevation and calendar scales for
# speed.
target_dates <- shoreline_date(target_points,
                               elevation = c(65, 70),
                               elev_reso = 10,
                               cal_reso = 500)

sum_shoredates(target_dates)