plotKML (version 0.2-4)

spMetadata.Spatial: Generate spatial metadata from an sp object

Description

Tries to generate metadata from an external file. If no metadata file is available, tries to fill in missing columns based on the data properties.

Usage

spMetadata.Spatial(obj, xml.file, generate.missing = TRUE, Citation_title,  
    Target_variable, Attribute_Measurement_Resolution = 1, 
    Attribute_Units_of_Measure = "NA",
    Indirect_Spatial_Reference = "", GoogleGeocode = FALSE, 
    Enduser_license_URL = get("license_url", envir = plotKML.opts),
    signif.digit = 3, colour_scale, bounds, legend_names, icons, 
    validate.schema = FALSE)

Arguments

obj

some "Spatial" class object with "data" slot

xml.file

(optional) metadata file in the FGDC format

generate.missing

logical; species whether the program should try to generate missing metadata automatically

Citation_title

one-sentence title of the object

Target_variable

target variable i.e. column name in the data slot

Attribute_Measurement_Resolution

numeric resolution (typically estimated as half the measurement precision)

Attribute_Units_of_Measure

physical units of the target variable

Indirect_Spatial_Reference

name of the closest geographical location, town or village

GoogleGeocode

logical; specifies whether R should try to estimate Indirect Spatial Reference using Google maps API

Enduser_license_URL

end-user license specification (URL)

signif.digit

integer; a number of significant digits to round the numbers in the palette slot

colour_scale

collor scheme used to visualize this data

bounds

numeric vector; upper and lower limit bounds for the target variable

legend_names

(optional) manually inserted legend names

icons

(optional) manually inserted icon names for legend names

validate.schema

logical; specieis whether R should try to validate your xml file

Details

spMetadata.Spatial tries to locate a metadata file in the working directory (it looks for a metadata file with the same name as the object name). If no .xml file exists, it will load the template xml file available in the system folder (system.file("FGDC.xml", package="plotKML")).

See Also

SpatialMetadata-class

Examples

data(eberg)
coordinates(eberg) <- ~X+Y
proj4string(eberg) <- CRS("+init=epsg:31467")
# (a) no metadata file exist:
eberg.md <- spMetadata(eberg, Target_variable="SNDMHT_A")
# (b) with localy prepared metadata file:
eberg.md <- spMetadata(eberg, xml.file=system.file("eberg.xml", package="plotKML"), 
Target_variable="SNDMHT_A")