get_global_min_area: Get the minimum area

Description Usage Arguments Value Author(s) Examples

View source: R/DAISIE_max_rates.R

Description

Get the minimum area

Usage

1
get_global_min_area(totaltime, area_pars, peak, island_ontogeny, sea_level)

Arguments

totaltime

Numeric defining the length of the simulation in time units.

area_pars

A named list containing area and sea level parameters as created by create_area_pars():

  • [1]: maximum area

  • [2]: current area

  • [3]: value from 0 to 1 indicating where in the island's history the peak area is achieved

  • [4]: total island age

  • [5]: amplitude of area fluctuation from sea level

  • [6]: frequency of sine wave of area change from sea level

  • [7]: angle of the slope of the island

peak

A numeric value specifying the peakiness (or shaprness) of the ontogeny curve. Higher values imply peakier ontogeny. This value is internally calculated by calc_peak() given the area at the present and the area_pars.

island_ontogeny

In DAISIE_sim_time_dependent(), DAISIE_ML_CS and plotting a string describing the type of island ontogeny. Can be "const", "beta" for a beta function describing area through time. String checked by is_island_ontogeny_input().
In all other functions a numeric describing the type of island ontogeny. Can be 0 for constant, 1 for a beta function describing area through time. In ML functions island_ontogeny = NA assumes constant ontogeny.

sea_level

In DAISIE_sim_time_dependent() and plotting a string describing the type of sea level. Can be "const" or "sine" for a sine function describing area through time. String checked by is_sea_level_input().
In all other functions a numeric describing the type of sea level. Can be 0 for constant, 1 for a sine function describing area through time.

Value

Numeric with time at which area is minimum during the simulation

Author(s)

Pedro Neves, Joshua Lambert, Shu Xie

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
timeval <- 1
totaltime <- 10
area_pars <- DAISIE::create_area_pars(
  max_area = 5000,
  current_area = 4000,
  proportional_peak_t = 0.5,
  total_island_age = 15,
  sea_level_amplitude = 0,
  sea_level_frequency = 0,
  island_gradient_angle = 0
)
island_ontogeny <- 1
sea_level <- 0
peak <- DAISIE:::calc_peak(totaltime = totaltime, area_pars = area_pars)

testthat::expect_silent(
  DAISIE:::get_global_min_area(
    totaltime = totaltime,
    area_pars = area_pars,
    peak = peak,
    island_ontogeny = island_ontogeny,
    sea_level = sea_level
  )
)

DAISIE documentation built on Aug. 26, 2020, 5:12 p.m.