getRes: Read a result-file of 'califlopp'

In RCALI: Calculation of the Integrated Flow of Particles Between Polygons

Read a result-file of 'califlopp'

Description

Return the results stored on a file created by califlopp.

Usage

getRes(ficres)

Arguments

ficres

Pathname of a result-file created by califlopp.

Value

A data.frame with as many rows as pairs of polygons on the file. The columns are:

poly1, poly2	Identifiers of the polygons.
mean.flow/area	Integrated flow divided by the area of the second polygon. If several dispersion functions have been studied, as many columns as functions. The columns labels are then mean.flow.f1/area, mean.flow.f2/area, etc...
area1, area2	Areas of the polygons in squared meters.
mean.flow, conf.int.lower, conf.int.upper, abs.err, n.eval	when the method is "cubature", only: integrated flow, lower and upper bounds of the confidence interval, absolute error, number of evaluations. If several dispersion functions have been studied, the columns labels are suffixed with ".f1", "f2", etc...
mean.flow, std	when the method is "grid", only: mean of the integrated flow, standard deviation. If several dispersion functions have been studied, the columns labels are suffixed with ".f1", "f2", etc...

Note

This function works when RCALI has been configured with OUTPUT_FILE_FORMAT = LIGHT only (this is the default; see the file src/caliconfig.h to be sure your configuration is compatible).

Details about the returned values can be found in the Reference Manual.

See Also

califlopp

RCALI documentation built on Jan. 13, 2023, 5:12 p.m.