qgis_using_json_input: Report if JSON objects are used for input to and output from...

In qgisprocess: Use 'QGIS' Processing Algorithms

Report if JSON objects are used for input to and output from 'qgis_process'

Description

Returns a logical that reveals whether the JSON input and output methods are used, respectively.

Usage

qgis_using_json_input()

qgis_using_json_output(query = FALSE, quiet = TRUE)

Arguments

query	Use TRUE to refresh the cached value.
quiet	Use FALSE to display more information, possibly useful for debugging.

Details

Since QGIS 3.24 the JSON input method of 'qgis_process' is used by default when calling the command. It allows for more complex input argument types in certain algorithms that require a more complex input argument, e.g. a list of lists (see qgis_list_input()).

Likewise, JSON output is the default output format requested from 'qgis_process'.

The settings can be overruled with the options qgisprocess.use_json_input or qgisprocess.use_json_output, and with the environment variables R_QGISPROCESS_USE_JSON_INPUT or R_QGISPROCESS_USE_JSON_OUTPUT. Since the JSON output method is cached by the package, qgis_using_json_output(query = TRUE) is needed for these settings to take effect if the package was loaded already.

Value

A logical of length 1.

See Also

Other topics about programming or debugging utilities: qgis_result_status(), qgis_run(), qgis_tmp_file(), qgis_unconfigure()

Other topics about reporting the QGIS state: has_qgis(), qgis_algorithms(), qgis_path()

Examples

qgis_using_json_input()

qgisprocess documentation built on Aug. 17, 2023, 5:14 p.m.