CSmosquitoSp.analysis: CSmosquitoSp spatial analysis

Description Usage Arguments Value Author(s) See Also Examples

View source: R/CSmosquitoSp_analysis.R

Description

This function perform spatial analysis for a selected AOI using data from the CSmosquitoSp DataBase

Usage

1
2
CSmosquitoSp.analysis(input_db, aoi, start_date, end_date, method = "CM",
  full_clean = FALSE, aoi_name = NULL, ...)

Arguments

input_db

DataFrame. Input CSmosquitoSp DataBase imported using function CSmosquitoSp.import.

aoi

Character. Area Of Interest where to perform the spatial analysis.

start_date

Character. Input start date, either an object of class Date or a character object with format 'YYYY-MM-DD'.

end_date

Character. Input end date, either an object of class Date or a character object with format 'YYYY-MM-DD'.

method

Character. Method to be used for the analysis. The following options are supported: 'CM' (Class Median), 'RC' (ReClass) (default to 'CM').

full_clean

Logical. Wheter the full cleaning of the input DataBase should be performed prior the analysis.

aoi_name

Character. Name for the Area Of Interest when 'aoi' argument is supplied as external file.

...

Additional arguments to be passed through to function CSmosquitoSp.analysis

Value

The function returns an object of class CSmosquitoSp.obj containing the following slots:

Author(s)

Federico Filipponi, Mattia Manica

See Also

CSmosquitoSp.plot CSmosquitoSp.export CSmosquitoSp.import

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
# perform CSmosquitoSp spatial analysis
for the metropolitan area of the city of Rome
CSMS_roma <- CSmosquitoSp.analysis(input_db=input_db,
aoi="Roma", start_date="2017-09-01", end_date="2017-09-01")

# perform CSmosquitoSp spatial analysis using the 'full_clean' option
for the metropolitan area of the city of Rome
CSMS_roma_full_clean <- CSmosquitoSp.analysis(input_db=input_db,
aoi="Roma", start_date="2017-09-01", end_date="2017-09-01", full_clean=TRUE)

## End(Not run)

ffilipponi/CSmosquitoSp documentation built on July 2, 2020, 6:25 p.m.