geoknife (version 1.6.11)

geoknife: geoknife

Description

Creates the processing job and allows specifying the processing details.

Usage

geoknife(stencil, fabric, knife = webprocess(...), show.progress = TRUE, ...)

Value

and object of class geojob

Arguments

stencil

a webgeom, simplegeom, or any type that can be coerced into simplegeom.

fabric

a dataset. A webdata or any type that can be coerced into webdata

knife

(optional) a webprocess object

show.progress

logical (optional) display progress bar?

...

additional arguments passed to new webprocess. Can also be used to modify the knife argument, if it is supplied.

Details

The stencil argument is akin to cookie cutter(s), which specify how the dataset is to be sub-sampled spatially. Supported types are all geometric in nature, be they collections of points or polygons. Because geoprocessing operations require a non-zero area for stencil, if points are used (i.e., the different point collections that can be used in simplegeom), there is a negligible automatic point buffer applied to each point to result in a non-zero area.

Naming of the components of the stencil will impact the formatting of the result returned by the geoknife processing job (the geojob)

geoknife will check the class of the stencil argument, and if stencil's class is not webgeom, it will attempt to coerce the object into a simplegeom. If no coercion method exists, geoknife will fail.

The fabric argument is akin to the dough or fabric that will be subset with the stencil argument. At present, this is a web-available gridded dataset that meets a variety of formatting restrictions. Several quick start methods for creating a webdata object (only webdata or an type that can be coerced into webdata are valid arguments for fabric).

Making concurrent requests to the Geo Data Portal will NOT result in faster overall execution times. The data backing the system is on high performance storage, but that storage is not meant to support parallelized random access and can be significantly slower under these conditions.

Examples

if (FALSE) {
job <- geoknife(stencil = c(-89,42), fabric = 'prism')
check(job)

#-- set up geoknife to email user when the process is complete

job <- geoknife(webgeom("state::Wisconsin"), fabric = 'prism', email = '[e-mail]')

}