Merge branch 'main' of https://github.com/FluvialGeomorph/fluvgeo

NAMESPACE

@@ -43,6 +43,7 @@ export(planform_dimensions)
 export(reach_rhg_graph)
 export(sf2arc)
 export(sf2arc_table)
+export(sf2csv)
 export(shear_stress)
 export(slope_sinuosity)
 export(stream_power)

R/sf2csv.R

@@ -0,0 +1,22 @@
+#' @title Save `sf` object to a .csv file.
+#'
+#' @export
+#' @param sf_object    `sf` object; The object whose data frame will be saved
+#'                     as a csv file.
+#' @param csv_path     character; Path to the output csv file.
+#'
+#' @return Writes the `sf_object` as a csv file specified by
+#' `csv_path`
+#'
+sf2csv <- function(sf_object, csv_path) {
+  # Check parameters
+  assert_that("sf" %in% class(sf_object),
+              msg = "sf_object must be of class `sf`")
+
+  # Remove geometry
+  df <- sf::st_drop_geometry(sf_object)
+
+  # write sf_object data frame to csv file
+  readr::write_csv(x = df,
+                   file = csv_path)
+}

tests/testthat/test_sf2csv.R

@@ -0,0 +1,12 @@
+library(fluvgeo)
+
+forward_slash_path <- function(fc_path) {
+  gsub("\\\\", "/", fc_path)
+}
+
+test_that("check output csv file exists", {
+  sf_object  <- fluvgeo::sin_flowline_sf
+  csv_path <- forward_slash_path(tempfile(fileext = ".csv"))
+  sf2csv(sf_object = sf_object, csv_path = csv_path)
+  expect_true(file.exists(csv_path))
+})