Package 'raveclusters'

Calculate cluster centroid and mean standard error

Description

Calculate cluster centroid and mean standard error

Usage

cluster_mse(indata_plot, cluster)

---

Calculate clustering index

Description

Calculate clustering index

Usage

cluster_index_methods(simplify = TRUE)

cluster_index(
  x,
  cluster,
  dist,
  dist_args = list(),
  methods = "default",
  check = TRUE
)

best_criterion(index)

best_nclusters(index)

Arguments

simplify	whether to return unlisted method names
x	numerical matrix of original data (dimension: sample size times number of variate)
cluster	integer vector or matrix of the clustering results. see 'Details'
dist	distance matrix of x, used by 'silhouette' and 'c_index'. If missing, then the value will be automatically calculated from dist function with additional arguments specified by dist_args
dist_args	see dist
methods	cluster index criterion; a full list can be obtained via cluster_index_methods(). Alternatively, you can specify methods='default' or methods='all' to apply default or all criterion accordingly.
check	see 'Details'
index	the table returned by function cluster_index

Details

When cluster is an integer vector, its length must be equal to the sample size. The observations with the same integer are considered to be in the same cluster. If cluster is a matrix, then its row must be consistent with the sample size.

For 'ball_hall', 'trace_w', 'trace_wib', and 'log_ss_ratio', cluster must be a matrix so best_criterion and best_nclusters can work properly. In addition, the number of clusters indicated by cluster columns must be increasing. The cluster_index will check cluster by default, which can be disabled by specifying check=FALSE

---

Convert 'RAVE' cluster results into a readable table

Description

Convert 'RAVE' cluster results into a readable table

Usage

convert_cluster_table(x, split_by = "A", var = "C", value = "B")

Arguments

x	a list of cluster results
split_by	variable name to be split by; for example, 'Subject'
var	variable name indicating the cluster results; for example, 'Cluster'
value	the name of variable to concatenate into a single string or cell value; for example, 'Electrode'

Value

A data.frame that is readable

---

Function to load all dev funtions and wrap them within an environment

Description

Function to load all dev funtions and wrap them within an environment

Usage

dev_raveclusters(expose_functions = FALSE, reload = TRUE)

Arguments

expose_functions	logical indicating whether to expose all dev functions to the global environment
reload	logical, do you want to fast-reload the package before load the functions?

---

Data import functions used to locate data exported by power explorer module.

Description

Data import functions used to locate data exported by power explorer module.

Usage

scan_power_explorer_exports(search_paths, pattern = "\\.fst$")

find_source(search_paths, fname)

import_configurations(search_paths, file_names)

Arguments

search_paths	directories to search for data
pattern	search regular expression pattern
fname	character vector of length 1: file name to locate within search_paths
file_names	vector of fname to import

Value

potential file names to be loaded

---

Global variables used by 'RAVE' clustering module

Description

Global variables used by 'RAVE' clustering module

Usage

RAVE_ROI_KEY

shiny_cex.main

Format

An object of class character of length 1.

An object of class numeric of length 1.

---