R/garrett_example.R

In GarrettRank: Garrett Ranking Analysis and Visualization

#' #Example Dataset for Garrett Ranking
#'
#' # An example dataset demonstrating the application of the Garrett ranking method.
#' The dataset contains ranking responses from 50 respondents for 22 constraints.
#' @format A data frame with 50 rows and 23 columns:
#' \describe{
#'   \item{Respondent}{The name or serial number identifying each respondent.}
#'   \item{C1}{Rank assigned to constraint 1.}
#'   \item{C2}{Rank assigned to constraint 2.}
#'   \item{C3}{Rank assigned to constraint 3.}
#'   \item{C4}{Rank assigned to constraint 4.}
#'   \item{C5}{Rank assigned to constraint 5.}
#'   \item{C6}{Rank assigned to constraint 6.}
#'   \item{C7}{Rank assigned to constraint 7.}
#'   \item{C8}{Rank assigned to constraint 8.}
#'   \item{C9}{Rank assigned to constraint 9.}
#'   \item{C10}{Rank assigned to constraint 10.}
#'   \item{C11}{Rank assigned to constraint 11.}
#'   \item{C12}{Rank assigned to constraint 12.}
#'   \item{C13}{Rank assigned to constraint 13.}
#'   \item{C14}{Rank assigned to constraint 14.}
#'   \item{C15}{Rank assigned to constraint 15.}
#'   \item{C16}{Rank assigned to constraint 16.}
#'   \item{C17}{Rank assigned to constraint 17.}
#'   \item{C18}{Rank assigned to constraint 18.}
#'   \item{C19}{Rank assigned to constraint 19.}
#'   \item{C20}{Rank assigned to constraint 20.}
#'   \item{C21}{Rank assigned to constraint 21.}
#'   \item{C22}{Rank assigned to constraint 22.}
#' }
#'
#' @details
#' The first column contains the respondent's name or serial number.
#' The remaining 22 columns (C1 to C22) contain the ranks assigned
#' by each respondent to the corresponding constraints. There are
#' 50 respondents in the dataset. No tied ranks are present in the
#' dataset.
#'
#' @examples
#' data(garrett_example)
#' #Run Garrett ranking analysis
#' result <- garrett_rank(garrett_example,respondent = "Respondent")
#' summary(result)
#' result$ranking
#' result$frequency
#' result$weighted_scores
#' #Select the plot type
#' plot(result, type = "bar")
#' plot(result, type = "lollipop")
#' plot(result, type = "dot")
#' plot(result, type = "line")
#' plot(result, type = "heatmap")
#' plot(result, type = "cluster")
#' plot(result,type="contribution")
#' plot(result, type = "cluster", k = 3)
#' plot(result,type = "cluster",scale = "row",show_numbers = TRUE)
#'
#' #Run Kendall's Coefficient of Concordance
#' kw<-kendall_w(garrett_example,respondent = "Respondent")
#' summary(kw)
"garrett_example"