update docs

helske · Nov 21, 2024 · cd2e943 · cd2e943
1 parent d36d4c7
commit cd2e943
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -48,7 +48,7 @@ S3method(nobs,hmm)
 S3method(nobs,mhmm)
 S3method(nobs,mnhmm)
 S3method(nobs,nhmm)
-S3method(plot,ame)
+S3method(plot,ame_params)
 S3method(plot,hmm)
 S3method(plot,mhmm)
 S3method(plot,ssp)

diff --git a/R/plot.ame.R b/R/plot.ame.R
@@ -1,14 +1,14 @@
-#' Visualize Average Marginal Effects
+#' Visualize Average Marginal Effects on NHMM parameters
 #' 
-#' @param x Output from [ame_param() or ame_prob()].
+#' @param x Output from [ame_param()].
 #' @param type Type of plot to create. One of `"initial"`, `"transition"`,
 #'  `"emission"`, or `"cluster"`.
 #' @param probs A numeric vector of length 2 with the lower and upper limits for 
 #' confidence intervals. Default is `c(0.025, 0.975)`. If the limits are not 
 #' found in the input object `x`, an error is thrown.
 #' @param ... Ignored.
 #' @export
-plot.ame <- function(x, type, probs = c(0.025, 0.975), ...) {
+plot.ame_params <- function(x, type, probs = c(0.025, 0.975), ...) {
 
   type <- match.arg(type, c("initial", "transition", "emission", "cluster"))
 

diff --git a/man/plot.ame.Rd → man/plot.ame_params.Rd b/man/plot.ame.Rd → man/plot.ame_params.Rd