parse_odkc_version: Parse a given ODK Central version string or number into a...

In dbca-wa/ruODK: An R Client for the ODK Central API

Parse a given ODK Central version string or number into a semver.

Description

Usage

parse_odkc_version(v, env_var = "ODKC_VERSION")

Arguments

v	A string (e.g. "ODKC_VERSION=") or number (e.g. 0.8, 1.5) of a complete or partial semver, or a semver of class "svlist".
env_var	A string indicating which environment variable was targeted. This is used in the warning to advise which environment variable to update. If set to an empty string, the warning message is suppressed. Default: "ODKC_VERSION".

Details

Past versions of ruODK advised to set ODKC_VERSION to a floating point number indicating major and minor versions, e.g. ODKC_VERSION=0.7 or ODKC_VERSION=1.5.

ODK Central has since switched to semantic versioning, e.g. ⁠ODKC_VERSION=ODKC_VERSION=⁠.

To preserve backwards compatibility, ruODK handles both formats gracefully, but emits a helpful warning to update the version string if the older format is detected, or the version string is missing the minor or patch version.

Value

semver::svlist The version as semver of major, minor, and patch.

See Also

Other ru_settings: odata_svc_parse(), ru_settings(), ru_setup(), semver_gt(), semver_lt(), yell_if_error(), yell_if_missing()

Examples

parse_odkc_version("1.2.3")

# Warn: too short
parse_odkc_version("1")
parse_odkc_version("1.2")

# Warn: too long
parse_odkc_version("1.2.3.4")

# Warn: otherwise invalid
parse_odkc_version("1.2.")
parse_odkc_version(".2.3")

dbca-wa/ruODK documentation built on Nov. 8, 2024, 4:09 a.m.