Skip to contents

Get topsoil thickness for 'Australian Areas of Intensive Agriculture of Layer 1' for local use

Usage

get_topsoil_thickness(cache = TRUE)

Arguments

cache

Caches the topsoil thickness data files after download using tools::R_user_dir() to identify the proper directory for storing user data in a cache for this package. Defaults to TRUE, caching the files locally. If FALSE, this function uses tempdir() and the files are deleted upon closing of the active R session.

Value

A read.abares.topsoil.thickness object, which is a named list() with the fs::path_file() of the data file and text file of metadata.

Details

The topsoil thickness data will be saved as a GeoTIFF file in the user's cache if cache = TRUE.

Note

A custom print() method is provided that will print the metadata associated with these data. Examples are provided for interacting with the metadata directly.

Examples

if (FALSE) { # interactive()
x <- get_topsoil_thickness()

# View the metadata with pretty printing
x

# Extract the metadata as an object in your R session and use it with
# {pander}, useful for Markdown files

library(pander)
y <- x$metadata
pander(y)
}