composeUrl: Compile the URL to query the CLMS API

View source: R/composeUrl.R

composeUrlR Documentation

Compile the URL to query the CLMS API

Description

This function compiles REST query (URL) that can be submitted to the server.

Usage

composeUrl(
  productType = c("FSC", "RLIE", "PSA", "PSA-LAEA", "ARLIE"),
  geometry,
  publishedAfter,
  publishedBefore,
  startDate,
  completionDate,
  productIdentifier,
  cloudCover = 100,
  textualSearch,
  maxRecords = 1000
)

Arguments

productType

character. One of: FSC, RLIE, PSA, PSA-LAEA, ARLIE

geometry

The area of interest. See geo2char for inputs.

publishedAfter

character. Data published after: YYYY-MM-DD

publishedBefore

character. Data published before: YYYY-MM-DD

startDate

character. Sensing Date after: YYYY-MM-DD

completionDate

character. Sensing Date before: YYYY-MM-DD

productIdentifier

character. Find products using elements of the filename: FSC_20170913T114531_S2B_T29UNV_V001_0: e.g. FSC_2020, TileID, etc. (its not regex though)

cloudCover

integer. 0-100%. Maximum allowed Cloud cover

textualSearch

character e.g. Winter in Finland

maxRecords

numeric or character maximum returns per page.

Value

Returns an URL character that can be submitted to the Server API.

Author(s)

Matteo Mattiuzzi

Examples

composeUrl(productType = 'FSC', productIdentifier = 'T29UNV')


MatMatt/clmsapi documentation built on Feb. 4, 2023, 9:08 a.m.