encounter_diagnostics: Plot diagnostics for a single encounter-rate transit

View source: R/encounter_diagnostics.R

encounter_diagnosticsR Documentation

Plot diagnostics for a single encounter-rate transit

Description

Plot diagnostics for a single encounter-rate transit

Usage

encounter_diagnostics(transits, id = NULL, wait = TRUE)

Arguments

transits

The result of encounter_rate() in which runs is set to 1.

id

The iteration ID for which you want a detailed diagnostic plot. Can be left NULL, which will begin at the first iteration then step through every iteration in the transits object until you press Escape.

wait

Boolean, with default TRUE, indicating if you want R to wait for you to press Enter between each iteration, or just move automatically through the entire transits object.

Value

A series of diagnostic plots depicting the details of a close-encounter simulation iteration.


ericmkeen/shipstrike documentation built on May 21, 2023, 7:05 a.m.