are_area_pars: Test if list has area parameters

View source: R/DAISIE_check_format.R

are_area_parsR Documentation

Test if list has area parameters

Description

Test if list has area parameters

Usage

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]: 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

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

testit::assert(DAISIE:::are_area_pars(
  create_area_pars(
    max_area = 10,
    current_area = 4,
    proportional_peak_t = 0.5,
    total_island_age = 5,
    sea_level_amplitude = 5,
    sea_level_frequency = 10,
    island_gradient_angle = 0)))

DAISIE documentation built on June 2, 2022, 5:07 p.m.