CHANGELOG.md

In flahn/openeo-r-client: openEO client interface

Changelog

[1.0.0] -

In general this release will cover the changes between API versions 0.4.2 and 1.0.0 without backward compatibility. Changes in the data models due to the new API are not listed here.

Note: similarly named functions that work on different objects are abrreviated by a *, e.g. describe_*() for describe_job(), describe_service(), ...

Added

• added a serialization of object Parameter into a descriptive form
• added a function to parse and coerce an R function into a Graph (e.g. as(x,"Graph"), where x is a R function returning a ProcessNode)
• new functions privacy_policy() and terms_of_service() to view the privacy policy and the terms of service
• function conformance() operated on the new corresponding api endpoint
• added class ProcessCollection in order to divide the Graph object and the graph building. It is created upon connection and obtainable via processes().
• added a function logs(), log_job() and log_service() to request the back-end logs of a job or a service. The logging blocks the console and requests every second an update of the log at the back-end. Also when queing a job via start_job() an immediate logging can be triggered.
• added S3 class labels, coerce and print functions for some exchange object:
• FileFormatList (as.data.frame.FileFormaList)
• FileFormat (print.FileFormat)
• ServiceType (print.ServiceType)
• ServiceList (as.data.frame.ServiceList, print.ServiceList)
• Service (print.Service)
• CollectionList
• Collection (print.Collection)
• Log (print.Log)
• Job (print.Job)
• JobList (print.JobList)
• ResultList (print.ResultList)
• AssetList (as.data.frame.AssetList)
• ProcessInfo (as.Graph.ProcessInfo)
• UdfRuntime (as.character.UdfRuntime)
• UdfRuntimeList
• CubeDimension (as.character.CubeDimension)
• CubeDimensions (print.CubeDimensions)
• ProcessInfo (as.Process.ProcessInfo)
• implemented the RStudio connection interface which shows the active connection and the available data sets with their dimensional description
• added classes for arguments: UdfRuntimeArgument, UdfRuntimeVersionArgument, UdfCodeArgument
• implemented and added a class ArgumentList to Process in order to allow an easier value assignment, e.g. node1$parameter$x = ..., which comes in handy, when the node is assigned to a variable and a parameter has to changed later
• added a builder for user-defined processes (UserProcessCollection and user_processes()) like ProcessCollection for predefined processes, which offers a users stored process graph as a usable function that creates a ProcessNode

Fixed

• improved reading of files [#50]

Changed

• added more setter functions to Parameter parent class in order to manipulate parameter representations later, when defining Parameters in user defined processes
• ProcessGraph as a parameter requires a function wrapping - meaning you should not pass an openeo process like p$min directly, because with the elaborated ProcessGraphParameter we cannot do a reliable automatic variable matching, e.g. often the ProcessGraphParameter "context" is misinterpreted
• updated and externalized the scripts in the *_viewer() functions to visualize collection and processes following the new api definition
• anyOf was dropped as a top-level parameter definition schema in the API. The parameter anyOf is still be used in the client.
• classes were renamed:
• Callback was renamed into ProcessGraphArgument (Graph is still a different Concept), which is used in reducer or aggregation functions
• callback-value was renamed into ProcessGraphParameter
• unset ProcessGraphParameter are derived automatically from R functions that are passed as ProcessGraphArgument (former Callback) and they become parameters that shall be set by a user upon use of this user defined graph
• updated the endpoint file for version 1.0.0
• adapted the exchange models (JSON models) and their parsing / serialization to the new API accordingly, especially in the print functions
• harmonized various function behavior:
• update_* and create_* functions return their respective object (e.g. update_job --> Job) instead of their ID (previous behaviour)
• list_* functions return a named list of those particular exchange objects (e.g. list_jobs --> named list of Job)
• parameters, where before only the ID of particular object was passed on, were changed to allow the overview or detailed object description also
• the Graph object does not hold a reference about the available data sets any longer
• the user defined processes management exchanges now Process objects instead of former Graph objects with the back-end
• when creating and storing user defined processes on a back-end, they now require a distinct id selected by the user
• updating an user defined process is done via replacement, so the old representation is queried in the update_process_graph and merged with the new information given by the function parameter
• renamed functions
• list_file_formats() to list_file_formats()
• list_process_graphs() to list_user_processes()
• describe_process_graph() to describe_user_process()
• delete_process_graph() to delete_user_process()
• create_process_graph() to create_user_process()
• update_process_graph() to update_user_process()
• validate_process_graph() to validate_process()
• FileFormat object can passed to OutputFormat parameter
• in addition to ID also the objects of respective list_* and describe_* can be passed as parameter
• old *Info class names are reduced to the respective shorter class name without "Info", except for ProcessInfo
• print functions of exchange objects obtained by list_* and describe_* are labeled with the same class and printed with the information available (either overview or detailed view)
• made the OIDC connection configurable by the user, since the user needs a client id and secret by the back-end provider
• enabled and reimplemented the GeoJson argument
• when starting the computation of a job you can trigger the immediate request to the job log with parameter log at start_job()

Removed

• removed funtion follow_job() (replaced by log_job())
• removed the field connection which linked to the used openEO client from the process graph object
• removed function process_graph_builder()
• removed function callback(), because those Process Graphs are either created from an R function or an resulting ProcessNode
• removed URL encoding procedure when managing files on the back-end
• removed user_id as a parameter from the files request, because the user information is send with the bearer token

[0.6.2] - 2020-04-09

Fixed

• interpretation of send_udf response into correct json
• tibble version 3.0.0 issue, when searching for endpoints in the endpoint mapping [#49]

Changed

• send_udf can now handle user_context
• send_udf has now a parameter for legacy support (which calls the legacy endpoint of a UDF service with API version 0.1.0)
• String parameter can now handle file paths and calls (in context with run_udf openEO process) [#48]

Added

• URI parameter

[0.6.1] - 2020-03-23

Fixed

• fixed #46 were the process link of arguments was not set correctly

Removed

• package dependency commonmark

[0.6.0] - 2020-02-27 Usability update

Added

• added a collection visualization in a HTML viewer based on "openEO JS commons"
• bridging towards the "openEO JS commons" by reusing the process viewer, a new function process_viewer spawns now a viewer in RStudio and renders a beautiful website containing the process information
• function processes that will create an object that has the processes that are available on the connected openEO service. It is quite similar to the return value of process_graph_builder which will create a Graph object with basically the same functionality plus the graph related functions
• transferred a function to directly interact with UDF services from an example script of R UDF service repository send_udf and added documentation to the function
• added an example script for the new callback functions
• added a Rmd for the new callback behavior

Changed

• variables are decoupled from the graph object which means more flexibility when dealing with variables, they will be parsed from the Graph / end node
• it is no longer needed to create a Graph object explicitly, passing the end node of the defined workflow is now possible.
• connection is not required to be passed into the functions that directly interact with the openEO service, active_connection now gets and sets the latest connected service into a package variable
• the mathematical constants pi and e (in R pi and exp(1)) are parsed from the data and translated into the corresponding openEO processes in order to avoid errors due to rounded values
• overloaded mathematical operators for ProcessNode and callback-value classes
• allowed functions as "callbacks" for reducer function, e.g. in reduce or apply (not only for band arithmetics)
• processes can now be created from any graph in callbacks provided as functions
• slight change for indirect parameter order in processes (backward compatible)

Fixed

• fixed the server sided validation response handling (HTTP 200 were always OK, despite having errors)
• fixed bad ordering of bounding box parameter

Removed

• removed the markdownViewer function in favour of process_viewer and collection_viewer
• removed the function band_arithmetics, because callbacks can now be functions

[0.5.0] - 2019-12-03

Added

• example process graph building for minimum EVI with EURAC, EODC and VITO
• added a Google OIDC authentication option
• band_arithmetics function that parses a mathematical function into a process graph if the back-end supports some of the core processes
• example script shown in the open geo hub summer school
• notebooks for comparing the NDVI calculation on EURAC back-end and GEE

Changed

• modified connect with new parameters exchange_token and external. With the latter we can specify 'google' as an external identity provider and with exchange_token we can specify if we send the default access_token or the id_token as Bearer token in the authentication header
• some endpoints allowed optional sending of a bearer token in the header, which was not yet considered. Added a function to check if a user has logged in (OpenEOClient$isLoggedIn()) and made it optional at the following endpoints to sent a Bearer token as Authorization-header depending on whether the user is logged in:

GET /output_formats
GET /udf_runtimes
GET /service_types
GET /collections
GET /collections/{collection_id}
GET /processes
POST /validation

• modified gee-evi-example now that the GEE driver supports all relevant openeo processes, it now creates the graph with apply, linear_scale and saves it as PNG; added also an example for the band_arithmetics use case
• client public function client_version was renamed into api_version and returns the openEO API version which the client uses
• graphs are initialized with a connection instead of the parsed processes list
• connection is now available via a private field in the Graph object
• callback now reuses the obtained process in JSON format of the connection

Fixed

• fixed callback function which not replaced the AnyOf parameter with the newly created Graph
• create_job now refers to the HTTP response header "OpenEO-Identifier" rather than parsing the "Location" header
• fixed a problem in band_arithmetics where the parameter in array_element were falsely assigned
• fixed callback function to recognize nested callback arguments in anyOf (#35)
• fixed the attempt to parse the response body when evaluating HTTP 202
• typo in the README

[0.4.2] - 2019-09-09

Changed

• modified the Use case 1 RClient -> EURAC example (mostly working) based on API version 0.4.2
• return a list of file paths on download_results

Fixed

• fixed error on list_file_types
• fixed bad JSON graph formatting when sending a graph for immediate computation (compute_result)

flahn/openeo-r-client documentation built on Sept. 18, 2020, 5:16 a.m.