Updated docs

iflint1 · Nov 13, 2023 · 9c48652 · 9c48652
1 parent 61787b1
commit 9c48652
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 12 deletions.
diff --git a/R/chord_diagram.R b/R/chord_diagram.R
@@ -1,10 +1,8 @@
-#' Plot the coefficients of a fit object.
+#' Plot a chord diagram of the coefficients of a fit object.
 #'
-#' The coefficients and corresponding confidence intervals are shown in a box-like plot.
-#' The inner thick parts of the error bars represent numerical uncertainty, due to the number and distribution of dummy points.
-#' The outer thin part of the error bars represent the total statistical + numerical uncertainty.
-#' Formally, these are theoretical asymptotic 95% confidence intervals.
-#' As a convenience, this function can alternatively be applied by calling `plot` on a fit object.
+#' The coefficients are shown in a chord diagram.
+#' Highlighted opaque interactions are statistically significant.
+#' The types are ordered according to their mean interaction, or alternatively sorted into classes if the `classes` argument is set.
 #'
 #' @param fit A fit object obtained by a call to `ppjsdm::gibbsm`.
 #' @param coefficient A string representing the coefficient to plot.

diff --git a/man/chord_diagram_plot.Rd b/man/chord_diagram_plot.Rd