spectral_clustering: Generate report spectral clustering

View source: R/utils_module.R

spectral_clusteringR Documentation

Generate report spectral clustering

Description

Generates a pdf report with the results of a spectral clustering

Usage

spectral_clustering(
  pks,
  mass_range = c(min(pks$mass), max(pks$mass)),
  num_clus = 3,
  f = mean,
  generate_pdf = F,
  normalization = "None",
  legend_pos = "topright"
)

Arguments

pks

Input Peak Matrix

mass_range

Vector containing the minimum and maximum masses to be used in the process. The default is the complete mass range.

num_clus

Number of clusters to use. Defaults to 3.

f

Function to use when plotting the resulting spectral clusters in the spatial domain. The function should take a numerical vector and return a single number. Default is mean

generate_pdf

Boolean value indicating if a pdf report needs to be produced

normalization

String indicating the normalization technique to use. Possible values: "None", "TIC","RMS", "MAX" or "AcqTic"

legend_pos

String indicating the legend position. "bottomright","bottomleft", "topleft" or "topright"

Value

Matrix containing the masses processed along with the cluster to which each of them is assigned


gbaquer3/rMSIcleanup documentation built on Feb. 24, 2023, 2:58 p.m.