Package 'rwfs'

Title: R Clients for Open Geospatial Consortium's Web Feature Services
Description: R clients for Open Geospatial Consortium's (OGC) Web Feature Services (WFS).
Authors: Joona Lehtomaki [aut, cre], Jussi Jousimo [aut], Juuso Parkkinen [ctb], Leo Lahti [ctb]
Maintainer: Joona Lehtomaki <[email protected]>
License: BSD_2_clause + file LICENSE
Version: 0.2.0
Built: 2025-01-30 11:23:32 UTC
Source: https://github.com/rOpenGov/rwfs

Help Index


Returns date time string in ISO8601 format

Description

Converts an object which can be converted to a POSIXlt object to a ISO8601 date time string.

Usage

asISO8601(dt)

Arguments

dt

Date time object which can be converted to a POSIXlt object.

Value

Character string in ISO8601 format.

Author(s)

Jussi Jousimo [email protected]

Examples

asISO8601("2014-01-01")

A class for providing a file name reference to a GML document

Description

A class for providing a file name reference to a GML document.

Super class

rwfs::WFSRequest -> GMLFile

Methods

Public methods

Inherited methods

Method new()

Usage
GMLFile$new(srcFile)

Method getDataSource()

Usage
GMLFile$getDataSource()

Method clone()

The objects of this class are cloneable with this method.

Usage
GMLFile$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jussi Jousimo [email protected]


WFS client for R

Description

This R package provides a client to access Web Feature Services (WFS) (http://www.opengeospatial.org/standards/wfs).

Details

The client relies on the GDAL (http://www.gdal.org/) library and the rgdal (https://cran.r-project.org/package=rgdal) package, which should be installed first.

See examples in the fmi (http://www.github.com/rOpenGov/fmi) and the gisfin packages (http://www.github.com/rOpenGov/gisfin) how to inherit the abstract R6 classes (https://cran.r-project.org/package=R6) provided by the package.

Author(s)

Jussi Jousimo [email protected]


Downloads response from a WFS and parses the intermediate file

Description

Dispatches a WFS request, saves the response to a file and parses the file. The data can be converted using ogr2ogr of RGDAL. Provides a caching mechanism for subsequent queries on the same data.

Super class

rwfs::WFSClient -> WFSCachingClient

Methods

Public methods

Inherited methods

Method saveGMLFile()

Usage
WFSCachingClient$saveGMLFile(destFile)

Method loadGMLFile()

Usage
WFSCachingClient$loadGMLFile(fromFile)

Method listLayers()

Usage
WFSCachingClient$listLayers()

Method getLayer()

Usage
WFSCachingClient$getLayer(layer, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
WFSCachingClient$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jussi Jousimo [email protected]

See Also

WFSRequest, WFSStreamingClient


An abstract class for building a URL reference to a WFS with a caching

Description

The abstract method getURL must be overloaded in a subclass to provide a request URL to a WFS service.

Super classes

rwfs::WFSRequest -> rwfs::WFSStreamingRequest -> WFSCachingRequest

Methods

Public methods

Inherited methods

Method getDataSource()

Usage
WFSCachingRequest$getDataSource()

Method clone()

The objects of this class are cloneable with this method.

Usage
WFSCachingRequest$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jussi Jousimo [email protected]


Class represeting a WFS client

Description

An abstract class to represent OGC's WFS client in R. Other client classes in this package inherit this this class.

Format

R6Class object.

Methods

new(request)

This method is used to create object of this class with request as the request object containing WFS connection information and methods. NOTE: as this is abstract class, you shouldn't be creating instances of it.

setRequest(request)

Set client's request object to request, which must inherit from WFSRequest.

listLayers()

Not implemented in this abstract class, but it classes inheriting this class.

getLayer

Not implemented in this abstract class, but it classes inheriting this class.

getRaster

Get a raster layer from WFS

Public fields

test

Active bindings

test

Methods

Public methods


Method new()

Usage
WFSClient$new(request)

Method setRequest()

Usage
WFSClient$setRequest(request)

Method listLayers()

Usage
WFSClient$listLayers()

Method getLayer()

Usage
WFSClient$getLayer(layer, ...)

Method getRaster()

Usage
WFSClient$getRaster(parameters)

Method clone()

The objects of this class are cloneable with this method.

Usage
WFSClient$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jussi Jousimo [email protected], Joona Lehtomaki [email protected]

See Also

WFSStreamingClient, WFSCachingClient, WFSRequest


An abstract class for referencing a WFS or a GML document

Description

This class should be inherited and the abstract method getDataSource overloaded in a subclass to provide a reference.

Methods

Public methods


Method getDataSource()

Usage
WFSRequest$getDataSource()

Method print()

Usage
WFSRequest$print(...)

Method clone()

The objects of this class are cloneable with this method.

Usage
WFSRequest$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jussi Jousimo [email protected]

See Also

WFSClient, GMLFile


Streams response from a WFS

Description

Dispatches a WFS request and parses response from the stream directly.

Super class

rwfs::WFSClient -> WFSStreamClient

Methods

Public methods

Inherited methods

Method listLayers()

Usage
WFSStreamingClient$listLayers()

Method getLayer()

Usage
WFSStreamingClient$getLayer(layer, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
WFSStreamingClient$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jussi Jousimo [email protected]

See Also

WFSRequest, WFSCachingClient


An abstract class for building a URL reference to a WFS

Description

An abstract class for building a URL reference to a WFS.

Super class

rwfs::WFSRequest -> WFSStreamingRequest

Methods

Public methods

Inherited methods

Method getParameters()

Usage
WFSStreamingRequest$getParameters()

Method setPath()

Usage
WFSStreamingRequest$setPath(path)

Method setParameters()

Usage
WFSStreamingRequest$setParameters(...)

Method getCapabilities()

Usage
WFSStreamingRequest$getCapabilities(version = "1.0.0", ...)

Method getFeature()

Usage
WFSStreamingRequest$getFeature(version = "1.0.0", typeNames, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
WFSStreamingRequest$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Author(s)

Jussi Jousimo [email protected]