R/epikit_exports.R

In R4EPI/r4epi: Report templates and helper functions for applied epidemiology

# These functions have been re-exported from the {epidict} package. They were
# previously part of the sitrep package, but have been moved into their own
# separate package for maintenance. By re-exporting them, the user does not
# see much of a difference.
#

#' Exported functions from epikit
#'
#' @seealso [epikit::add_weights_cluster()], [epikit::add_weights_strata()],
#' [epikit::age_categories()], [epikit::assert_positive_timespan()],
#' [epikit::augment_redundant()],
#' [epikit::constrain_dates()], [epikit::dots_to_charlist()],
#' [epikit::fac_from_num()], [epikit::find_breaks()],
#' [epikit::find_date_cause()], [epikit::find_end_date()],
#' [epikit::find_start_date()], [epikit::fmt_ci()],
#' [epikit::fmt_ci_df()], [epikit::fmt_count()], [epikit::fmt_pci()],
#' [epikit::fmt_pci_df()], [epikit::group_age_categories()],
#' [epikit::merge_ci_df()], [epikit::merge_pci_df()],
#' [epikit::rename_redundant()],
#' [epikit::unite_ci()], [epikit::zcurve()]
#'
#' @name add_weights_cluster
#' @importFrom epikit add_weights_cluster
#' @rdname epikit-exports
#' @export
epikit::add_weights_cluster

#' @name add_weights_strata
#' @importFrom epikit add_weights_strata
#' @rdname epikit-exports
#' @export
epikit::add_weights_strata

#' @name age_categories
#' @importFrom epikit age_categories
#' @rdname epikit-exports
#' @export
epikit::age_categories

#' @name assert_positive_timespan
#' @importFrom epikit assert_positive_timespan
#' @rdname epikit-exports
#' @export
epikit::assert_positive_timespan



#' @name augment_redundant
#' @importFrom epikit augment_redundant
#' @rdname epikit-exports
#' @export
epikit::augment_redundant

#' @name constrain_dates
#' @importFrom epikit constrain_dates
#' @rdname epikit-exports
#' @export
epikit::constrain_dates

#' @name dots_to_charlist
#' @importFrom epikit dots_to_charlist
#' @rdname epikit-exports
#' @export
epikit::dots_to_charlist

#' @name fac_from_num
#' @importFrom epikit fac_from_num
#' @rdname epikit-exports
#' @export
epikit::fac_from_num

#' @name find_breaks
#' @importFrom epikit find_breaks
#' @rdname epikit-exports
#' @export
epikit::find_breaks

#' @name find_date_cause
#' @importFrom epikit find_date_cause
#' @rdname epikit-exports
#' @export
epikit::find_date_cause

#' @name find_end_date
#' @importFrom epikit find_end_date
#' @rdname epikit-exports
#' @export
epikit::find_end_date

#' @name find_start_date
#' @importFrom epikit find_start_date
#' @rdname epikit-exports
#' @export
epikit::find_start_date

#' @name fmt_ci
#' @importFrom epikit fmt_ci
#' @rdname epikit-exports
#' @export
epikit::fmt_ci

#' @name fmt_ci_df
#' @importFrom epikit fmt_ci_df
#' @rdname epikit-exports
#' @export
epikit::fmt_ci_df

#' @name fmt_count
#' @importFrom epikit fmt_count
#' @rdname epikit-exports
#' @export
epikit::fmt_count

#' @name fmt_pci
#' @importFrom epikit fmt_pci
#' @rdname epikit-exports
#' @export
epikit::fmt_pci

#' @name fmt_pci_df
#' @importFrom epikit fmt_pci_df
#' @rdname epikit-exports
#' @export
epikit::fmt_pci_df

#' @name gen_polygon
#' @importFrom epikit gen_polygon
#' @rdname epikit-exports
#' @export
epikit::gen_polygon

#' @name gen_population
#' @importFrom epikit gen_population
#' @rdname epikit-exports
#' @export
epikit::gen_population

#' @name group_age_categories
#' @importFrom epikit group_age_categories
#' @rdname epikit-exports
#' @export
epikit::group_age_categories

#' @name merge_ci_df
#' @importFrom epikit merge_ci_df
#' @rdname epikit-exports
#' @export
epikit::merge_ci_df

#' @name merge_pci_df
#' @importFrom epikit merge_pci_df
#' @rdname epikit-exports
#' @export
epikit::merge_pci_df

#' @name rename_redundant
#' @importFrom epikit rename_redundant
#' @rdname epikit-exports
#' @export
epikit::rename_redundant

#' @name unite_ci
#' @importFrom epikit unite_ci
#' @rdname epikit-exports
#' @export
epikit::unite_ci

#' @name zcurve
#' @importFrom epikit zcurve
#' @rdname epikit-exports
#' @export
epikit::zcurve