Commit 77f0616b authored by Dorchies David's avatar Dorchies David
Browse files

docs(create_uniform_reach_txt): argument singular

Refs #19
1 merge request!14Resolve "create_uniform_reach_txt: add singular sections"
Pipeline #34646 passed with stage
in 2 minutes and 25 seconds
Showing with 6 additions and 1 deletion
+6 -1
......@@ -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)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment