eqcat: Check earthquake catalog

View source: R/eqcat.R

eqcatR Documentation

Check earthquake catalog

Description

Preliminary check of the names of an earthquake catalog. summary and plot methods for earthquake catalogs are defined.

Usage

eqcat(x)
## S3 method for class 'eqcat'
plot(x,extended=TRUE,...)
## S3 method for class 'eqcat'
summary(object,extended=TRUE,...)

Arguments

x

an earthquake catalog.

object

an eqcat object.

extended

if TRUE some extra summary functions are computed.

...

other arguments.

Details

Minimal check of an earthquake catalog; checks only if it is suitable for the use as argument of the functions of etasFLP (mainly etasclass); checks only the presence of variables with the names time, lat, long, z, magn1. summary and plot methods are defined for earthquake catalogs. and the input object can be the cat output of eqcat

Value

If the catalog passes the check, then the catalog is returned in the object cat with the new class name eqcat; otherwise an error message is printed.

cat

the input catalog is returned. If the check is ok, this is an eqcat class object.

ok

A flag: TRUE if the check is ok; FALSE elsewhere.

Note

In this first version if you have a catalog without the depth (z), please insert however a constant column. The depth can be used only in some plot and not in the estimation routines of the package etasFLP; etasclass uses only time, lat, long, magn1. From version 2.0 you could use z as a covariate for the triggered component

Author(s)

Marcello Chiodi

See Also

etasclass

Examples

## Not run: 
data(italycatalog)
f=eqcat(italycatalog)
print(f$ok)
summary(f$cat)
plot(f$cat)

## End(Not run)

etasFLP documentation built on Sept. 14, 2023, 5:06 p.m.