temporal_metrics_sds: Calculates a temporal values for a user defined time period...

In sarahsmithtripp/SatelliteMetrics: A package for calculating simple satellite metrics

Calculates a temporal values for a user defined time period and user defined function. Example function included in the documentation.

Description

Calculates a temporal values for a user defined time period and user defined function. Example function included in the documentation.

Usage

temporal_metrics_sds(
  sds_choose,
  time_length,
  last_year,
  eval_funct,
  polygon,
  disturbance_year,
  parent_folder
)

Arguments

sds_choose	this is a spatrasterdataset where each spat raster is stacked annually
time_length	what is the time length to calculate over ?
last_year	last year of the dataset to calculate last metric to go by
eval_funct	functions to evaluate for temporal metrics
polygon	region to clip spat raster dataset by
disturbance_year	optional argument to state what you would like to calculate by
parent_folder	a folder that designates where to store the files

Value

metrics

Examples

## Not run: 
A an examples of the function summary input by the user
funSummary <- function(x){

  c(
    median = median(x,na.rm=TRUE),
    IQR = IQR(x,na.rm=TRUE),
   slope = foster::theilSen(x)
  )
}

## End(Not run)

sarahsmithtripp/SatelliteMetrics documentation built on July 25, 2022, 1:34 a.m.