R/gpat_read_distmtx.R

Defines functions gpat_read_distmtx

Documented in gpat_read_distmtx

#' Read a GeoPAT distance matrix
#'
#' Read a GeoPAT distance matrix into R
#'
#' @param x A filepath to the geoPAT 2 distance matrix file
#'
#' @return dist
#'
#' @importFrom readr read_csv
#' @importFrom stats as.dist
#'
#' @examples
#' distmtx_filepath = system.file("rawdata/Augusta2011_matrix_grid.csv", package="rgeopat2")
#' my_distmtx = gpat_read_distmtx(distmtx_filepath)
#'
#' @export

gpat_read_distmtx = function(x){
  as.dist(suppressMessages(read_csv(x, progress = FALSE))[, -1])
}
Nowosad/rgeopat2 documentation built on Sept. 19, 2023, 12:30 a.m.