smapr (version 0.2.1)

extract_smap: Extracts contents of SMAP data

Description

Extracts datasets from SMAP data files.

Usage

extract_smap(data, name, in_memory = FALSE)

Arguments

data

A data frame produced by download_smap() that specifies input files from which to extract data.

name

The path in the HDF5 file pointing to data to extract.

in_memory

Logical. Should the result be stored in memory? If not, then raster objects are stored on disk in the cache directory. By default the result is stored on disk.

Value

Returns a RasterStack object.

Details

The arguments group and dataset must refer specifically the group and name within group for the input file, such as can be obtained with list_smap(). This function will extract that particular dataset, returning a Raster object.

Examples

# NOT RUN {
files <- find_smap(id = "SPL4SMGP", dates = "2015-03-31", version = 4)
downloads <- download_smap(files[1, ])
sm_raster <- extract_smap(downloads, name = '/Geophysical_Data/sm_surface')
# }