wbt_principal_component_analysis: Principal component analysis

View source: R/math_stat_analysis.R

wbt_principal_component_analysisR Documentation

Principal component analysis

Description

Performs a principal component analysis (PCA) on a multi-spectral dataset.

Usage

wbt_principal_component_analysis(
  inputs,
  output,
  num_comp = NULL,
  standardized = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

inputs

Input raster file paths, concatenated with "," or ";". See wbt_file_path() for details.

output

Output HTML report file.

num_comp

Number of component images to output; <= to num. input images.

standardized

Perform standardized PCA?.

wd

Changes the working directory. Default: NULL will use the value in WhiteboxTools settings, see wbt_wd() for details.

verbose_mode

Sets verbose mode. If verbose mode is FALSE, tools will not print output messages. Default: NULL will use the value in WhiteboxTools settings, see wbt_verbose() for details.

compress_rasters

Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: NULL will use the value in WhiteboxTools settings, see wbt_compress_rasters() for details.

command_only

Return command that would be executed by system() rather than running tool. Default: FALSE.

Value

Returns the tool text outputs.


whitebox documentation built on Nov. 19, 2023, 1:07 a.m.