checkStatus: Check the status of an existing LANDFIRE Product Service...

View source: R/checkStatus.R

checkStatusR Documentation

Check the status of an existing LANDFIRE Product Service (LFPS) request

Description

checkStatus checks if a previous request is complete and downloads available data

Usage

checkStatus(landfire_api, verbose = TRUE, method = "curl")

Arguments

landfire_api

landfire_api object returned from landfireAPIv2()

verbose

If FALSE suppress all status messages

method

Passed to utils::download.file(). See ?download.file or use "none" to skip download and use landfire_vsi()

Value

Returns a landfire_api object with named elements:

  • request - list with elements query, date, url, job_id, request,dwl_url

  • content - Informative messages passed from API

  • response - Full response

  • status - Final API status, one of "Failed", "Succeeded", or "Timed out"

  • time - time of job completion

  • path - path to save directory

Examples

## Not run: 
products <-  c("ASP2020", "ELEV2020", "230CC")
aoi <- c("-123.7835", "41.7534", "-123.6352", "41.8042")
email <- "email@example.com"
resp <- landfireAPIv2(products, aoi, email, background = TRUE)
checkStatus(resp)

## End(Not run)

rlandfire documentation built on June 8, 2025, 11:44 a.m.