quantiles_input: Create an input file for Fortran program Quantiles.

View source: R/input_file_utils.R

quantiles_inputR Documentation

Create an input file for Fortran program Quantiles.

Description

Program Quantiles reads a raster file and computes quantiles over a moving circular window. For each iteration of the window, the interquartile range is determined and outliers, based on a Tukey's fence with k = 1.5, are removed. Quartiles are then recalculated using the remaining values and the minimum and maximum range

Usage

quantiles_input(
  in_raster = "nofile",
  radius = 0,
  buffer = 0,
  out_outlier = "nofile",
  out_q1 = "nofile",
  out_q2 = "nofile",
  out_q3 = "nofile",
  out_mean = "nofile",
  out_zscore = "nofile",
  out_prob = "nofile",
  scratch_dir = "none"
)

Arguments

in_raster

Character: The file name (full path) for the input raster.

radius

Numeric (dbl): radius in meters for the moving window

buffer

Numeric (dbl): spacign between moving window center points, in raster cells.

out_outlier

Character: output file name (full path) for the outlier raster (optional)

out_q1

Character: output file name (full path) for the first-quartile raster (optional)

out_q2

Character: output file name (full path) for the median raster (optional)

out_q3

Character: output file name (full path) for the third-quartile raster (optional)

out_mean

Character: output file name (full path) for the mean raster

out_zscore

Character: output file name (full path) for the z-score raster

out_prob

Character: output file name (full path) for the probability raster (optional)

scratch_dir

Charcter: scratch directory

Value

There is no explicit return object, but an explicit side effect is writing to disk of the partial input file.


tabrasel/WetlandTools documentation built on June 1, 2025, 8:07 p.m.