simple_sews_methods: Spatial early-warning signals: display of trends

plot.simple_sews_testR Documentation

Spatial early-warning signals: display of trends

Description

Spatial early-warning signals: display of trends

Usage

## S3 method for class 'simple_sews_test'
plot(x, along = NULL, what = "value", display_null = TRUE, ...)

## S3 method for class 'simple_sews_list'
plot(x, along = NULL, ...)

Arguments

x

A simple_sews_test object (as provided by **_sews functions, such as generic_sews()

along

A vector providing values over which the indicator trend will be plotted. If NULL then the values are plotted sequentially in their original order.

what

The trendline to be displayed. Defaults to the indicator's values ("value") but other metrics can be displayed. Accepted values are "value", "pval", "difference" (obs - null mean), or "z_score" ( (obs - null mean) / (null sd) ).

display_null

Chooses whether a grey ribbon should be added to reflect the null distribution. Note that it can not be displayed when the trend line reflects something else than the indicator values (when what is not set to "value").

...

Other arguments are ignored.

Details

Note that the produced plot is adjusted depending on whether along is numeric or not.


spatialwarnings documentation built on Sept. 11, 2024, 8:55 p.m.