ximages: ximages

Description Usage Arguments Details Value See Also Examples

View source: R/ximages.R

Description

Downloading images from the POLARIS database.

Usage

1
ximages(locations, variables, statistics, layersdepths, localPath = tempdir())

Arguments

locations

A data.frame object with locations data.

variables

A vector with soil variable codes. There are 13 variables in the POLARIS database: ph (soil water pH), om (organic matter), clay, sand, silt, bd (bulk density), hb (bubbling pressure), n (pore size distribution), alpha (scale parameter inversely proportional to mean pore diameter), ksat (saturated hydraulic conductivity), lambda (pore size distribution index), theta_r (residual soil water content), and theta_s (saturated soil water content).

statistics

A vector with the distribution summary options. There are five options of summary statistics: mean, mode, median (p50), five (p5) and 95 (p95) percentiles.

layersdepths

A vector with the soil depth codes. There are six options of soil depth layers: 0_5, 5_15, 15_30, 30_60, 60_100, and 100_200 cm.

localPath

Path to store the images. Default: tempdir()

Details

For details on units check package repository.

Value

This function simply downloads the images from the POLARIS database, according to the user request. Images are saved under a new directory, called POLARISOut, within the localPath.

See Also

xplot,xsoil

Examples

1
2
3
4
5
6
7
8
## Not run: 
df_test <- exkansas
df_ximages <- ximages(locations = df_test,
                      variables = c('clay'),
                      statistics = c('mean'),
                      layersdepths = c('0_5'))

## End(Not run)

XPolaris documentation built on Sept. 24, 2021, 1:07 a.m.