R/ISMtools-package.R

In ISMtools: Interpretive Structural Modelling Analysis Tools

#' ISMtools: Interpretive Structural Modelling Analysis Tools
#'
#' A comprehensive toolkit for Interpretive Structural Modelling (ISM) and
#' MICMAC analysis. ISM is a methodology for identifying and summarizing
#' relationships among specific elements which define an issue or problem.
#'
#' @section Input Functions:
#' \describe{
#'   \item{\code{\link{create_relation_matrix}}}{Create or convert adjacency matrices}
#'   \item{\code{\link{convert_to_matrix}}}{Convert edge lists to adjacency matrices}
#'   \item{\code{\link{create_ssim}}}{Create SSIM (Structural Self-Interaction Matrix) template}
#'   \item{\code{\link{ssim_to_matrix}}}{Convert SSIM (V/A/X/O) to adjacency matrix}
#' }
#'
#' @section Core Analysis Functions:
#' \describe{
#'   \item{\code{\link{compute_reachability}}}{Calculate reachability matrix using Warshall's algorithm}
#'   \item{\code{\link{level_partitioning}}}{Perform hierarchical level decomposition}
#'   \item{\code{\link{micmac_analysis}}}{MICMAC analysis (driving/dependence power)}
#'   \item{\code{\link{extract_direct_edges}}}{Transitive reduction for clean diagrams}
#' }
#'
#' @section Visualization Functions:
#' \describe{
#'   \item{\code{\link{plot_ism}}}{Static ISM structure visualization (base R or igraph)}
#'   \item{\code{\link{plot_interactive_ism}}}{Interactive ISM visualization (requires visNetwork)}
#'   \item{\code{\link{plot_micmac}}}{MICMAC scatter plot}
#' }
#'
#' @section Typical Workflow:
#' \enumerate{
#'   \item Create SSIM using \code{\link{create_ssim}} or adjacency matrix using \code{\link{create_relation_matrix}}
#'   \item Convert SSIM to adjacency matrix using \code{\link{ssim_to_matrix}} (if applicable)
#'   \item Compute reachability matrix using \code{\link{compute_reachability}}
#'   \item Perform level partitioning using \code{\link{level_partitioning}}
#'   \item Perform MICMAC analysis using \code{\link{micmac_analysis}}
#'   \item Visualize results using \code{\link{plot_ism}} and \code{\link{plot_micmac}}
#' }
#'
#' @section Example Data:
#' The package includes an example dataset \code{\link{ism_example}} containing
#' a project risk factors adjacency matrix for demonstration purposes.
#'
#' @references
#' Warfield, J. N. (1974). Developing interconnection matrices in structural
#' modeling. \emph{IEEE Transactions on Systems, Man, and Cybernetics},
#' SMC-4(1), 81-87. \doi{10.1109/TSMC.1974.5408524}
#'
#' Sage, A. P. (1977). \emph{Interpretive Structural Modeling: Methodology for
#' Large-scale Systems}. McGraw-Hill.
#'
#' @docType package
#' @name ISMtools-package
#' @aliases ISMtools
#'
#' @importFrom graphics abline arrows legend par plot points polygon text
#' @importFrom grDevices hcl.colors
#' @importFrom stats median
"_PACKAGE"

# Suppress R CMD check note about undefined global functions
utils::globalVariables(c(".", "id", "level"))