get_sample: Get sample data

In openeo: Client Interface for 'openEO' Servers

Get sample data

Description

In order to inspect data locally a very small spatial extent will be processed, downloaded and made available in R.

Usage

get_sample(
  graph,
  replace_aoi = TRUE,
  spatial_extent = NULL,
  execution = "sync",
  immediate = TRUE,
  con = NULL,
  ...
)

Arguments

graph	a ProcessGraph, a Process or the final node in a process for which the sample shall be calculated
replace_aoi	a logical flag to indicate whether or not the original spatial extent shall be substituted with a different one, default TRUE
spatial_extent	a bounding box or a spatial feature from which to derive a bounding box
execution	sync or async which indicates the processing chain, a not "async" value results in a synchronous processing
immediate	flag to be considered if the retrieval shall be immediately queued on the back-end
con	connected and authenticated openEO client (optional) otherwise active_connection() is used.
...	additional parameters that are passed to compute_result() or create_job()

Details

In order to get a better understanding about the processing mechanisms and the data structures used in the openEO back-end, it helps to check the actual data from time to time. This function aids the user in doing to. It replaces all spatial extents of the derived process graph with a new spatial extent which is calculated by the first spatial extent of the mandatory openEO process 'load_collection'. We take the center of the extent and add 0.0003 degrees to it. In case the coordinate reference system is not in WGS84, then the bounding box will be transformed into geodetic WGS84 beforehand, if the package 'sf' is present.

If the spatial extent was explicitly set to a small custom extent, then you can disable the replacement of the area of interest with replace_aoi = FALSE.

openeo documentation built on Nov. 17, 2022, 5:07 p.m.