R/calcMeanConnectivityMatrix.R

In wStockhausen/rDisMELS: Basic functions for dealing with DisMELS IBM model output

#'
#' @title Calculate mean connectivity matrix
#'
#' @description Function to calculate a mean connectivity matrix (as a dataframe).
#'
#' @param tbl_conn - dataframe with connectivity information from which to extract means by startZone **x** endZone
#'
#' @return a dataframe with mean, median, and std dev. of connectivity values
#'
#' @details Mean, median, and std deviation of the \code{connFrac} column of the input
#' \code{tbl_conn} are calculated by startZone **x** endZone
#'
#' @import dplyr
#' @import magrittr
#' @import stats
#'
#' @export
#'
calcMeanConnectivityMatrix<-function(tbl_conn){
    tmp2 = tbl_conn %>%
              dplyr::group_by(startZone,endZone) %>%
              dplyr::summarise(meanFrac=mean(connFrac),sdFrac=stats::sd(connFrac),medFrac=stats::median(connFrac)) %>%
              dplyr::ungroup() %>%
              dplyr::mutate(meanPct=100*meanFrac,sdPct=100*sdFrac,medPct=100*medFrac);
    return(tmp2);
}