R/print.epicontacts.R

Defines functions print.epicontacts

Documented in print.epicontacts

#' Print method for epicontacts objects
#'
#' This method prints the content of \code{epicontacts} objects, giving a brief
#' summary of the reported cases and contacts.
#'
#' @export
#'
#' @author Thibaut Jombart (\email{thibautjombart@@gmail.com})
#'
#' @param x an \code{\link{epicontacts}} object
#'
#' @param ... further parameters to be passed to other methods (currently not used)
#'
print.epicontacts <- function(x, ...){
    cat("\n/// Epidemiological Contacts //\n")
    cat("\n  // class:", paste(class(x), collapse=", "))
    cat("\n  //", format(nrow(x$linelist),big.mark=","),
        "cases in linelist;",
        format(nrow(x$contacts), big.mark=","),
        "contacts; ", ifelse(x$directed, "directed", "non directed"),
        "\n")

    cat("\n  // linelist\n\n")
    print(dplyr::as_tibble(x$linelist))

    cat("\n  // contacts\n\n")
    print(dplyr::as_tibble(x$contacts))

    cat("\n")
}
Hackout3/contacts documentation built on March 2, 2024, 5:41 a.m.