R/rhr2md.R

In jmsigner/rhr: Reproducible Home Ranges with R

#' Markdown summary of Rhr* objections
#' 
#' Creates a markdown summary of an rhr object.
#'
#' @param x Object of class \code{RhrTrack*}
#' @export

rhr2md <- function(x) {
  UseMethod("rhr2md")
}

#' @export
rhr2md.RhrTrackS <- function(x) {
  
  xx <- summary(rhrSegments(x)$dist)
  xxv <- as.vector(xx)
  xxn <- names(xx)
  
  tab <- knitr::kable( data.frame(measure = xxn, distance = xxv), row.names = FALSE, digits = 3)
  capture.output(xx)
  
  md <- c(
    paste("# Relocation summary for:", "\n\n"), 
    paste("- **Number of relocations:**", rhrN(x), "\n\n"), 
    paste("## Track statistics:\n\n"),
    paste("### Step lengths:\n\n"),
    paste0("```\n",  
           paste0(capture.output(summary(rhrSegments(x)$dist)), collapse = "\n"), "\n```\n\n"))
  md
}