Skip to content

Commit

Permalink
fixing Note about itemize -> describe
Browse files Browse the repository at this point in the history
  • Loading branch information
borishejblum committed Jan 13, 2024
1 parent dbf3646 commit eed4109
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion R/cluster_est_binder.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#'partition from \code{c} used to break ties when minimizing the cost function
#'
#'@return a \code{list}:
#' \itemize{
#' \describe{
#' \item{\code{c_est}:}{ a vector of length \code{n}. Point estimate of the partition}
#' \item{\code{cost}:}{ a vector of length \code{N}. \code{cost[j]} is the cost
#' associated to partition \code{c[[j]]}}
Expand Down
6 changes: 4 additions & 2 deletions R/summary.DPMMclust.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@
#'@param ... further arguments passed to or from other methods
#'
#'@return a \code{list} containing the following elements:
#'\describe{
#'\item{\code{nb_mcmcit}:}{ an integer giving the value of \code{m}, the number of retained
#'sampled partitions, i.e. \code{(N - burnin)/thin}}
#'\item{\code{burnin}:}{ an integer passing along the \code{burnin} argument}
#'\item{\code{thin}:}{ an integer passing along the \code{thin} argument}
#'\item{\code{lossFn}:}{ a character string passing along the \code{lossFn} argument}
#'\item{\code{clust_distrib}:}{ a character string passing along the \code{clust_distrib} argument }
#'\item{\code{point_estim}:}{ a \code{list} containing: \itemize{
#'\item{\code{point_estim}:}{ a \code{list} containing: \describe{
#' \item{\code{c_est}:}{ a vector of length \code{n}containing the point estimated clustering for each observations}
#' \item{\code{cost}:}{ a vector of length \code{m} containing the cost of each sampled partition}
#' \item{\code{Fmeas}:}{ if \code{lossFn} is \code{'F-measure'}, the \code{m x m} matrix of total F-measures for each pair of sampled partitions}
Expand All @@ -43,7 +44,8 @@
#'\item{\code{logposterior_list}:}{ a list of length \code{m} containing the logposterior and its decomposition, for each sampled partition}
#'\item{\code{U_SS_list}:}{ a list of length \code{m} containing the containing the lists of sufficient statistics for all the mixture components,
#'for each sampled partition}
#'\item{\code{data}:}{ a \code{d x n} matrix containing the clustered data}
#'\item{\code{data}:}{ a \code{d x n} matrix containing the clustered data}
#'}
#'
#'
#'@details The cost of a point estimate partition is calculated using either a pairwise
Expand Down
2 changes: 1 addition & 1 deletion man/cluster_est_binder.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/summary.DPMMclust.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit eed4109

Please sign in to comment.