johrpan/geposan
1
0
Fork 0
mirror of https://github.com/johrpan/geposan.git synced 2025-10-26 10:47:25 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

clusteriness: Remove n_clusters and relation

Browse source
This commit is contained in:
Elias Projahn 2022-06-28 13:31:36 +02:00
parent 0ae6836d86
commit 260705785a
3 changed files with 8 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

15
man/clusteriness.Rd
View file

@ -4,13 +4,7 @@
\alias{clusteriness}
\title{Perform a cluster analysis.}
\usage{
clusteriness(
data,
span = 1e+05,
weight = 0.7,
n_clusters = NULL,
relation = NULL
)
clusteriness(data, span = 1e+05, weight = 0.7)
}
\arguments{
\item{data}{The values that should be scored.}
@ -21,13 +15,6 @@ clusteriness(
relation to the previous one. For example, if \code{weight} is 0.7 (the
default), the first cluster will weigh 1.0, the second 0.7, the third 0.49
etc.}
\item{n_clusters}{Maximum number of clusters that should be taken into
account. By default, all clusters will be regarded.}
\item{relation}{Number of items that the cluster size should be based on.
This should always at least the length of the data. By default, the length
of the data is used.}
}
\value{
A score between 0.0 and 1.0 summarizing how much the data clusters.