Commit b503ce0b authored by aho's avatar aho
Browse files

Revise the documentation about return values

parent 127814c3
Pipeline #5347 passed with stage
in 3 minutes and 19 seconds
......@@ -48,32 +48,45 @@
#'@return
#'A list containing:
#'\item{$cluster}{
#' An integer vector of the occurrence of a cluster along time, i.e., when
#' certain data member in time is allocated to a specific cluster.
#' An integer array of the occurrence of a cluster along time, i.e., when
#' certain data member in time is allocated to a specific cluster. The dimensions
#' are same as 'data' without 'space_dim'.
#'}
#'\item{$centers}{
#' A matrix of cluster centres or centroids (e.g. [1:K, 1:spatial degrees of freedom]).
#' A nemeric array of cluster centres or centroids (e.g. [1:K, 1:spatial degrees
#' of freedom]). The rest dimensions are same as 'data' except 'time_dim'
#' and 'space_dim'.
#'}
#'\item{$totss}{
#' A number of the total sum of squares.
#' A numeric array of the total sum of squares. The dimensions are same as 'data'
#' except 'time_dim' and 'space_dim'.
#'}
#'\item{$withinss}{
#' A vector of within-cluster sum of squares, one component per cluster.
#' A numeric array of within-cluster sum of squares, one component per cluster.
#' The first dimenion is the number of cluster, and the rest dimensions are
#' same as 'data' except 'time_dim' and 'space_dim'.
#'}
#'\item{$tot.withinss}{
#' A number of the total within-cluster sum of squares, i.e., sum(withinss).
#' A numeric array of the total within-cluster sum of squares, i.e.,
#' sum(withinss). The dimensions are same as 'data' except 'time_dim' and
#' 'space_dim'.
#'}
#'\item{$betweenss}{
#' A number of the between-cluster sum of squares, i.e. totss-tot.withinss.
#' A numeric array of the between-cluster sum of squares, i.e. totss-tot.withinss.
#' The dimensions are same as 'data' except 'time_dim' and 'space_dim'.
#'}
#'\item{$size}{
#' A vector of the number of points in each cluster.
#' A numeric array of the number of points in each cluster. The first dimenion
#' is the number of cluster, and the rest dimensions are same as 'data' except
#' 'time_dim' and 'space_dim'.
#'}
#'\item{$iter}{
#' An interger as the number of (outer) iterations.
#' A numeric array of the number of (outer) iterations. The dimensions are
#' same as 'data' except 'time_dim' and 'space_dim'.
#'}
#'\item{$ifault}{
#' An integer as an indicator of a possible algorithm problem.
#' A numeric array of an indicator of a possible algorithm problem. The
#' dimensions are same as 'data' except 'time_dim' and 'space_dim'.
#'}
#'
#'@references
......
......@@ -58,32 +58,45 @@ computation. The default value is NULL.}
\value{
A list containing:
\item{$cluster}{
An integer vector of the occurrence of a cluster along time, i.e., when
certain data member in time is allocated to a specific cluster.
An integer array of the occurrence of a cluster along time, i.e., when
certain data member in time is allocated to a specific cluster. The dimensions
are same as 'data' without 'space_dim'.
}
\item{$centers}{
A matrix of cluster centres or centroids (e.g. [1:K, 1:spatial degrees of freedom]).
A nemeric array of cluster centres or centroids (e.g. [1:K, 1:spatial degrees
of freedom]). The rest dimensions are same as 'data' except 'time_dim'
and 'space_dim'.
}
\item{$totss}{
A number of the total sum of squares.
A numeric array of the total sum of squares. The dimensions are same as 'data'
except 'time_dim' and 'space_dim'.
}
\item{$withinss}{
A vector of within-cluster sum of squares, one component per cluster.
A numeric array of within-cluster sum of squares, one component per cluster.
The first dimenion is the number of cluster, and the rest dimensions are
same as 'data' except 'time_dim' and 'space_dim'.
}
\item{$tot.withinss}{
A number of the total within-cluster sum of squares, i.e., sum(withinss).
A numeric array of the total within-cluster sum of squares, i.e.,
sum(withinss). The dimensions are same as 'data' except 'time_dim' and
'space_dim'.
}
\item{$betweenss}{
A number of the between-cluster sum of squares, i.e. totss-tot.withinss.
A numeric array of the between-cluster sum of squares, i.e. totss-tot.withinss.
The dimensions are same as 'data' except 'time_dim' and 'space_dim'.
}
\item{$size}{
A vector of the number of points in each cluster.
A numeric array of the number of points in each cluster. The first dimenion
is the number of cluster, and the rest dimensions are same as 'data' except
'time_dim' and 'space_dim'.
}
\item{$iter}{
An interger as the number of (outer) iterations.
A numeric array of the number of (outer) iterations. The dimensions are
same as 'data' except 'time_dim' and 'space_dim'.
}
\item{$ifault}{
An integer as an indicator of a possible algorithm problem.
A numeric array of an indicator of a possible algorithm problem. The
dimensions are same as 'data' except 'time_dim' and 'space_dim'.
}
}
\description{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment