ds.dist: Computes the distance matrix of a given data set

In FlorianSchw/dsClusterAnalysisClient: DataSHIELD client side functions for the dsClusterAnalysisClient package

Computes the distance matrix of a given data set

Description

This function is similar to the native R function from stats

Usage

ds.dist(
  df.name = NULL,
  method = "euclidean",
  newobj = NULL,
  datasources = NULL
)

Arguments

df.name	is a string character of the data set (either a data.frame or a matrix)
method	specifies the method for the distance matrix calculation and can be either 'euclidean', 'maximum', 'manhattan', 'canberra', 'binary' or 'minkowski'
newobj	is the name of the new object which is created with this function
datasources	a list of DSConnection-class objects obtained after login

Details

The function calls the server-side function distDS that computes the distance matrix of a data set (type data.frame or matrix) and assigns the new object to the server-side, which will be of class 'dist'. The new object is named by the user using the newobj argument, otherwise it is named dist.newobj by default.

Value

the object specified by the newobj argument of ds.dist or default name dist.newobj

Author(s)

Florian Schwarz for the German Institute of Human Nutrition

FlorianSchw/dsClusterAnalysisClient documentation built on Feb. 8, 2025, 10:32 a.m.