dot-apply_index: Maximum 1-day precipitation
In obaezvil/SpatIndex: Calculate spatially distributed hydroclimatological indices

.apply_index

R Documentation

Maximum 1-day precipitation

Maximum 1-day precipitation

.apply_index(
  rst_path,
  vct = NULL,
  start_date,
  end_date,
  init_month = NULL,
  index_fun,
  index_args = list()
)

`rst_path`	File path to either: 'GTiff files': Daily raster files that include the date in the file names (e.g., 'ProductX_1989-02-28.tif'). The dates must have the format '%Y-%m-%d'. 'NCDF files': Monthly raster files that contain the daily layers respective for that month. The file name must include the date (e.g., 'ProductX_1989-02.nc'). The dates must have the format '%Y-%m'.
`vct`	Vector file of the study area (Optional). It will be used to crop the spatial extent of the raster files if required. This parameter is set to 'NULL'
`start_date`	Position where the dates of the raster files start. For example, start_date = 10 for 'ProductX_1989-02-28.tif' as the date start in the 10th character.
`end_date`	Position where the dates of the raster files end. For example, end_date = 19 for 'ProductX_1989-02-28.tif', and end_date = 16 for 'ProductX_1989-02.nc'.
`init_month`	Numeric value that represents the initial month that will be used in the calculation of the indices for each year (1 = Jan, 2 = Feb, ...., 12 = December). This parameter is set to NULL meaning that if not specified, the year will start in January.
`index_fun`	The function that will be applied to the raster layers.
`index_args`	List of additional arguments to be passed to the selected function ('index_fun').