fix documentation mistakes for CRAN submission

add @return everywhere, remove \donttest{}, minor fixes

Author: bsiepe

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
 Version: 0.1.0
-Date: 2024-02-20 10:48:12 UTC
-SHA: df33272590580c7236c7f8357b53cf2e2794833a
+Date: 2024-02-20 15:36:22 UTC
+SHA: 40df86c9c02e76044b2499df231d4ddc43ce4940

DESCRIPTION

@@ -16,7 +16,7 @@ Authors@R:
   role = c("ctb"),
   comment = c(ORCID = "0000-0002-6302-9252")))
 Maintainer: Björn S. Siepe <bjoernsiepe@gmail.com>
-Description: Fit, compare, and visualize Bayesian graphical vector autoregressive (GVAR) network models using Stan. These models are commonly used in psychology to represent temporal and contemporaneous relationships between multiple variables in intensive longitudinal data. Fitted models can be compared with a test based on matrix norm differences of posterior point estimates to quantify the differences between two estimated networks. See also Siepe, Kloft & Heck (2024) <doi:10.31234/osf.io/uwfjc>.
+Description: Fit, compare, and visualize Bayesian graphical vector autoregressive (GVAR) network models using 'Stan'. These models are commonly used in psychology to represent temporal and contemporaneous relationships between multiple variables in intensive longitudinal data. Fitted models can be compared with a test based on matrix norm differences of posterior point estimates to quantify the differences between two estimated networks. See also Siepe, Kloft & Heck (2024) <doi:10.31234/osf.io/uwfjc>.
 License: GPL-3
 Encoding: UTF-8
 LazyData: true

R/centrality.R

@@ -118,7 +118,7 @@ get_centrality <- function(fitobj,
 #'   plot, distribution of the centrality measures is visualized.
 #'
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' data(fit_data)
 #' obj <- get_centrality(fit_data[[1]])
 #'   plot_centrality(obj,

R/check_eigen.R

@@ -13,6 +13,11 @@
 #'   [stan_fit_convert()).
 #' @param verbose Logical. If TRUE, a verbal summary of the results is printed.
 #'   Default is TRUE.
+#' @examples
+#'  data(fit_data)
+#'  fitobj <- fit_data[[1]]
+#'  result <- check_eigen(fitobj)
+#'
 #' @return A list containing the eigenvalues and a verbal summary of the
 #'   results.
 #' @export

R/compare_gvar.R

@@ -6,7 +6,7 @@
 #'   distance between two models based on their point estimates and compares
 #'   them using reference distributions created from their posterior
 #'   distributions. Returns the p-value for the comparison based on a decision
-#'   rule specified by the user. Details are available in Siepe, Kloft & Heck (2023)
+#'   rule specified by the user. Details are available in Siepe, Kloft & Heck (2024)
 #'   <doi:10.31234/osf.io/uwfjc>.
 #'
 #' @param fit_a Fitted model object for Model A. This can be a tsnet_fit object

R/plot_compare_gvar.R

@@ -24,6 +24,9 @@
 #' corresponding models (mod_a and mod_b). The empirical distances between the
 #' networks are indicated by red vertical lines.
 #'
+#' @return A ggplot object representing the density plots of the posterior
+#' uncertainty distributions for distances and the empirical distance for two GVAR models.
+#' 
 #' @import ggplot2
 #' @importFrom ggokabeito scale_fill_okabe_ito palette_okabe_ito
 #' @importFrom cowplot plot_grid get_legend

R/posterior_plot.R

@@ -16,6 +16,9 @@
 #' are shown. Lagged variables are displayed along the vertical line of the
 #' grid, and non-lagged variables along the horizontal line of the grids.
 #'
+#' @return A ggplot object representing the posterior distributions of the parameters of the temporal
+#' or the contemporaneous networks of a GVAR model.
+#'
 #' @import ggplot2
 #' @importFrom ggdist stat_pointinterval stat_slab
 #' @importFrom tidyr separate_wider_delim pivot_longer

R/posterior_samples.R

@@ -196,7 +196,7 @@ prepare_samples_plot <- function(fitobj,
 #' @importFrom rstan extract
 #' @importFrom posterior as_draws_matrix
 #' @examples
-#' \dontrun{
+#' \donttest{
 #' data(ts_data)
 #' example_data <- ts_data[1:100,1:3]
 #' fit <- stan_gvar(data = example_data,

cran-comments.md

@@ -2,4 +2,4 @@
 
 0 errors | 0 warnings | 1 note
 
-* This is a new release. Fixed previous URL mistake.
+* This is a new release. Fixed previous documentation mistakes.