From 77f0616bff6474a69cf89cb686398faf3a373dc8 Mon Sep 17 00:00:00 2001
From: Dorchies David <david.dorchies@irstea.fr>
Date: Thu, 7 Apr 2022 14:11:35 +0200
Subject: [PATCH] docs(create_uniform_reach_txt): argument singular
Refs #19
---
man/create_uniform_reach_txt.Rd | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/man/create_uniform_reach_txt.Rd b/man/create_uniform_reach_txt.Rd
index da7c02f..3006575 100644
--- a/man/create_uniform_reach_txt.Rd
+++ b/man/create_uniform_reach_txt.Rd
@@ -27,7 +27,7 @@ create_uniform_reach_txt(
\item{section_names}{\link{character} vector of section names}
-\item{singular}{\link{logical} \code{TRUE} for a singular section, \code{FALSE} for a regular section}
+\item{singular}{\link{numeric} vector of abscissas of singular sections (See details)}
}
\value{
A \link{list} from which each item is a section exported by \link{create_section_txt}.
@@ -36,6 +36,11 @@ Names of the list are the abscissas with trailing zeros for character sorting.
\description{
Generate text export geometry for an uniform reach
}
+\details{
+The abscissas of the \code{singular} parameter should match with sections
+abscissas defined by \code{abscissas}. \code{singular} values that don't match are silently
+ignored.
+}
\examples{
# Trapezoidal section
profT <- list(B = 2,S = 1, ZF = 100, ZB = 100 + 2)
--
GitLab