bkml: Generate a burstwise .kml file of a binClstPath_instance.

bkmlR Documentation

Generate a burstwise .kml file of a binClstPath_instance.

Description

bkml generates a burstwise .kml file of a binClstPath_instance, which can be viewed using Google Earth or other GIS software. At first issue, this command can take some time because bursted segmentation has to be computed.

Usage

bkml(obj, folder = "embcDocs", markerRadius = 15, display = FALSE)

## S4 method for signature 'binClstPath'
bkml(obj, folder = "embcDocs", markerRadius = 15, display = FALSE)

Arguments

obj

A binClstPath_instance.

folder

A character string indicating the name of the folder in which the .kml file will be saved. If the folder does not exist it is automatically created, (defaults to '~/embcDocs').

markerRadius

A numeric value indicating the radius of the markers to be plotted, (defaults to 5 pixels).

display

A boolean value (defaults to FALSE) to automatically launch Google-Earth from within R to visualize the generated .kml document. (Google Earth must already be installed on the system. In Windows, it must be associated with the .kml file type.)

Value

The path/name of the saved kml file.

See Also

pkml

Examples

## Not run: 
# -- apply EMbC to the example path --
mybcp <- stbc(expth,info=-1)
# -- generate a burstwise kml of the output --
bkml(mybcp)

## End(Not run)

EMbC documentation built on Oct. 3, 2023, 5:07 p.m.