R/khsmisc.R

In stopsack/khsmisc: Miscellaneous functions for epidemiology research

#' khsmisc: Miscellaneous functions for epidemiology research
#'
#' This package provides a set of custom functions for data handling, vector
#' manipulation, and tabulation, and plotting.
#'
#' @section Functions for data handling:
#'
#' \code{\link[khsmisc]{varlist}}: Variable list/dataset inventory, Stata style
#'
#' \code{\link[khsmisc]{write_csv_safely}}, \code{\link[khsmisc]{save_safely}},
#'  \code{\link[khsmisc]{pdf_safely}}:
#'  Export CSV files, R objects, or PDFs without overwriting existing files
#'
#' @section Functions for vectors:
#'
#' \code{\link[khsmisc]{scale_to_range}}: Scale a vector to a given range
#'
#' \code{\link[khsmisc]{Mode}}: Most common value
#'
#' \code{\link[khsmisc]{roundp}}: Round and format p-values
#'
#' @section Functions for descriptive tables:
#'
#' \code{\link[khsmisc]{tabulate_rowcol}}: A contingency table for categorical
#'   variables.
#'
#' \code{\link[khsmisc]{tsummary}}: A descriptive table for continuous variables
#'
#' @section Functions for plots:
#'
#' \code{\link[khsmisc]{stripplot}}: Box-whiskers/dot plot
#'
#' \code{\link[khsmisc]{corrmat}}: Correlation matrix
#'
#' \code{\link[khsmisc]{exclusion_flowchart}}: Flowcharts of exclusions from a study
#'
#' \code{\link[khsmisc]{geom_stepribbon}}: Step ribbon plots
#'
#' \code{\link[khsmisc]{brickchart}}: Brick chart
#'
#' @docType package
#' @name khsmisc
#' @keywords internal
#' @seealso \url{https://github.com/stopsack/khsmisc}
NULL
#> NULL