R/data_descriptions.R

In hdirector/ContouR: Implementing Gaussian Star-Shaped Contour Models (GSCMs)

#' Stop-sign Distributional Parameters
#'
#' Parameters to generate the distribution that looks like a stop sign. 
#'
#' @docType data
#'
#' @usage data(stop_sign)
#'
#' @format A list of parameters
#'
#' @keywords datasets
#'
#'
#' @examples
#' data(stop)
"stop_sign"

#' Bow Tie Distributional Parameters
#'
#' Parameters to generate the distribution that looks like a stop sign. 
#'
#' @docType data
#'
#' @usage data(tie)
#'
#' @format A list of parameters
#'
#' @keywords datasets
#'
#'
#' @examples
#' data(tie)
"tie"


#' Tree Distributional Parameters
#'
#' Parameters to generate the distribution that looks like a tree. 
#'
#' @docType data
#'
#' @usage data(tree)
#'
#' @format A list of parameters
#'
#' @keywords datasets
#'
#'
#' @examples
#' data(tree)
"tree"

#' Convex Polygon Points
#'
#' Points that form a convex polygon
#'
#' @docType data
#'
#' @usage data(convex_poly)
#'
#' @format A list of parameters
#'
#' @keywords datasets
#'
#'
#' @examples
#' data(convex_poly)
"convex_poly"


#' Approximately Convex Polygon Points
#'
#' Points that form a polygon that is not fully convex
#'
#' @docType data
#'
#' @usage data(convex_mod)
#'
#' @format A list of parameters
#'
#' @keywords datasets
#'
#'
#' @examples
#' data(convex_mod)
"convex_mod"

#' Modified Circle Points
#'
#' Points that approximately form a circle
#'
#' @docType data
#'
#' @usage data(circle_mod)
#'
#' @format A list of parameters
#'
#' @keywords datasets
#'
#'
#' @examples
#' data(circle_mod)
"circle_mod"

#' Curl Points
#'
#' Points that approximately form a circle with an additional area curled around 
#' it
#'
#' @docType data
#'
#' @usage data(curl)
#'
#' @format A list of parameters
#'
#' @keywords datasets
#'
#'
#' @examples
#' data(curl)
"curl"