Skip to contents

Read Australian Soil Classification (ASC) Data

Source: R/read_asc.R
read_asc.Rd

Wrapper around read_tern() for Australian Soil Classification (ASC) soil order classes at 90 m resolution. Returns character soil order descriptions (e.g., "2 - Sodosol") with optional mapping reliability (confusion index).

Usage

read_asc(
  confusion_index = FALSE,
  api_key = get_key(),
  max_tries = NULL,
  initial_delay = NULL
)

Source

ASC mosaic metadata (estimated soil-order class and confusion index): https://geonetwork.tern.org.au/geonetwork/srv/eng/catalog.search#/metadata/15728dba-b49c-4da5-9073-13d8abe67d7c. The underlying COG endpoints (ASC_EV_C_P_AU_TRN_N.cog.tif and ASC_CI_C_P_AU_TRN_N.cog.tif under /model-derived/slga/NationalMaps/SoilClassifications/ASC/90m/ on data.tern.org.au) require an authenticated request and are constructed internally by this package.

Arguments

confusion_index

A logical value. If FALSE (default), returns estimated ASC soil order classes (character). If TRUE, returns the Confusion Index (numeric, 0-100) indicating mapping reliability.

api_key

A character string containing your API key, a random string provided to you by TERN, for the request. Defaults to automatically detecting your key from your local .Renviron, .Rprofile or similar. Alternatively, you may directly provide your key as a string here or use functionality like that from keyring. If nothing is provided, you will be prompted on how to set up your R session so that it is auto-detected and a browser window will open at the TERN website for you to request a key.

max_tries

Maximum number of download retries before an error is raised. When NULL (default), resolved from getOption("nert.max_tries", 3L). Pass an integer to override for a single call.

initial_delay

Initial retry delay in seconds (doubles with each attempt). When NULL (default), resolved from getOption("nert.initial_delay", 1L). Pass an integer to override for a single call.

Value

A terra::rast() object.

Details

The ASC dataset provides soil order classifications based on the Australian Soil Classification system. Each pixel contains the predicted soil order and associated reliability/uncertainty estimates.

Output data type: Character (soil order names and codes)

Reliability: Confusion Index indicates mapping uncertainty (lower = more reliable)

References

https://geonetwork.tern.org.au/geonetwork/srv/eng/catalog.search#/metadata/15728dba-b49c-4da5-9073-13d8abe67d7c

See also

Other COGs: read_canopy_height(), read_phenology(), read_slga(), read_soil_diversity(), read_tern()

Examples

if (FALSE) { # interactive()

# Australian Soil Classification (soil orders as character)
r_asc <- read_asc()
autoplot(r_asc)

# Confusion Index (mapping reliability, lower = more reliable)
r_ci <- read_asc(confusion_index = TRUE)
autoplot(r_ci)
}