are_area_pars: Test if list has area parameters

Description Usage Arguments Value Author(s) Examples

View source: R/create_pars.R

Description

Test if list has area parameters

Usage

1
are_area_pars(area_pars)

Arguments

area_pars

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

  • [1]: maximum area

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

  • [3]: sharpness of peak

  • [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

Value

Boolean that indicates if list conforms to expected area parameters as created by create_area_pars

Author(s)

Richel J.C Bilderbeek, Joshua Lambert, Pedro Neves

Examples

1
2
3
4
5
6
7
8
9
testit::assert(DAISIE::are_area_pars(
  create_area_pars(
    max_area = 10,
    proportional_peak_t = 0.5,
    peak_sharpness = 1,
    total_island_age = 5,
    sea_level_amplitude = 5,
    sea_level_frequency = 10,
    island_gradient_angle = 0)))

xieshu95/DAISIE_new documentation built on March 20, 2020, 5:31 a.m.