refactor: change merge_reaches to merge method for Reachtxt objects

NAMESPACE

@@ -4,6 +4,7 @@ S3method(SicInput,POSIXt)
 S3method(SicInput,data.frame)
 S3method(SicInput,matrix)
 S3method(SicInput,numeric)
+S3method(merge,ReachTxt)
 S3method(merge,SicInput)
 export(SicInput)
 export(SicLocation)
@@ -19,7 +20,6 @@ export(get_result)
 export(get_result_tree)
 export(get_section_centers)
 export(loadConfig)
-export(merge_reaches)
 export(read_bin_result_matrix)
 export(set_boundary_ZQ)
 export(set_initial_conditions)

R/merge_reaches.R → R/merge.ReachTxt.R

 #' Merge several *ReachTxt* objects into one
 #'
-#' @param ... *ReachTxt* objects
+#' @param x First *ReachTxt* object to merge
+#' @param y Second *ReachTxt* object to merge
+#' @param ... Other *ReachTxt* objects to merge
 #'
 #' @return a *ReachTxt* object (See [create_uniform_reach_txt] and [dem_to_reach]) containing the merged reaches.
 #' @export
@@ -28,9 +30,9 @@
 #' maj_reach <- dem_to_reach_txt(dem, node_coords, space_step, section_width, major_bed = TRUE)
 #'
 #' # Merge reaches into one
-#' reach <- merge_reaches(min_reach, maj_reach)
-merge_reaches <- function(...) {
-  reaches <- list(...)
+#' reach <- merge(min_reach, maj_reach)
+merge.ReachTxt <- function(x, y = NULL, ...) {
+  reaches <- c(list(x, y), list(...))
   lapply(reaches, function(reach) {
     if (!inherits(reach, "ReachTxt")) stop("Parameters must be of class ReachTxt")
   })

R/sic_import_reaches.R

@@ -25,7 +25,7 @@
 #' maj_reach <- dem_to_reach_txt(dem, node_coords, space_step, section_width, major_bed = TRUE)
 #'
 #' # Merge minor and major beds and split into 2 reaches
-#' reach <- merge_reaches(min_reach, maj_reach)
+#' reach <- merge(min_reach, maj_reach)
 #' reaches <- split_reach(reach, seq(0, 10000, 5000))
 #'
 #' \dontrun{

man/merge_reaches.Rd → man/merge.ReachTxt.Rd

 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/merge_reaches.R
-\name{merge_reaches}
-\alias{merge_reaches}
+\name{merge.ReachTxt}
+\alias{merge.ReachTxt}
 \title{Merge several \emph{ReachTxt} objects into one}
 \usage{
-merge_reaches(...)
+\method{merge}{ReachTxt}(x, y = NULL, ...)
 }
 \arguments{
-\item{...}{\emph{ReachTxt} objects}
+\item{x}{First \emph{ReachTxt} object to merge}
+
+\item{y}{Second \emph{ReachTxt} object to merge}
+
+\item{...}{Other \emph{ReachTxt} objects to merge}
 }
 \value{
 a \emph{ReachTxt} object (See \link{create_uniform_reach_txt} and \link{dem_to_reach}) containing the merged reaches.
@@ -38,5 +42,5 @@ section_width = 5000
 maj_reach <- dem_to_reach_txt(dem, node_coords, space_step, section_width, major_bed = TRUE)
 
 # Merge reaches into one
-reach <- merge_reaches(min_reach, maj_reach)
+reach <- merge(min_reach, maj_reach)
 }

man/sic_import_reaches.Rd

@@ -41,7 +41,7 @@ section_width = 5000
 maj_reach <- dem_to_reach_txt(dem, node_coords, space_step, section_width, major_bed = TRUE)
 
 # Merge minor and major beds and split into 2 reaches
-reach <- merge_reaches(min_reach, maj_reach)
+reach <- merge(min_reach, maj_reach)
 reaches <- split_reach(reach, seq(0, 10000, 5000))
 
 \dontrun{

tests/testthat/test-merge_reaches.R → tests/testthat/test-merge.ReachTxt.R

@@ -5,7 +5,7 @@ profT <- list(
   ZF = 100,
   ZB = 100 + 2
 )
-min_reach <- create_uniform_reach_txt(abscissas = seq(0, 10000, 100),
+min_reach <- create_uniform_reach_txt(abscissas = seq(0, 10000, 500),
                          upstream_bed_elevation = 10 + 2000 * 0.002,
                          slope = 0.002,
                          section_type = "T",
@@ -15,12 +15,12 @@ min_reach <- create_uniform_reach_txt(abscissas = seq(0, 10000, 100),
 data("floodam_ead_dem")
 dem <- terra::rast(floodam_ead_dem)
 node_coords <- matrix(c(102550, 102550, 110000, 100000), ncol = 2)
-space_step = 100
+space_step = 500
 section_width = 5000
 maj_reach <- dem_to_reach_txt(dem, node_coords, space_step, section_width, major_bed = TRUE)
 
-test_that("merge_reaches should work", {
-  reach <- merge_reaches(min_reach, maj_reach)
+test_that("merge.ReachTxt should work", {
+  reach <- merge(min_reach, maj_reach)
   expect_s3_class(reach, "ReachTxt")
   expect_length(reach, length(min_reach) + length(maj_reach))
 })

tests/testthat/test-sic_import_reaches.R

@@ -19,7 +19,7 @@ section_width = 5000
 maj_reach <- dem_to_reach_txt(dem, node_coords, space_step, section_width, major_bed = TRUE)
 
 # Merge minor and major beds and split into 2 reaches
-reach <- merge_reaches(min_reach, maj_reach)
+reach <- merge(min_reach, maj_reach)
 reaches <- split_reach(reach, seq(0, 10000, 5000))
 
 test_that("Geometry Import works", {