LMoFit (version 0.1.6)

con_sam_lspace: Condition of sample lpoints, as inside/outside of specific L-spaces on the L-moments ratio diagram, using sample.

Description

Condition of sample lpoints, as inside/outside of specific L-spaces on the L-moments ratio diagram, using sample.

Usage

con_sam_lspace(sample, type = "s", Dist = "BrIII")

Arguments

sample

for a single site, sample is a vector of observations, e.x. FLOW_AMAX. For multiple sites, sample is a dataframe consisting of multiple columns where each column has the data observed at one site; this dataframe should have column names as station names, e.x. FLOW_AMAX_MULT.

type

the type of the sample. It can be "s" for single site, the default, or "m" for multiple sites.

Dist

select the distribution to plot its L-space in the background. This can be "BrIII" for Burr Typr-III distribution, "BrXII" for Burr Typr-XII distribution, or "GG" for Generalized Gamma distribution. The default Dist is "BrIII".

Value

The condition of the L-points in regards to the selected L-space as inside or outside.

Examples

# NOT RUN {
con_sam_lspace(LMoFit::FLOW_AMAX, type = "s", Dist = "BrIII")
con_sam_lspace(LMoFit::FLOW_AMAX, type = "s", Dist = "BrXII")
con_sam_lspace(LMoFit::FLOW_AMAX, type = "s", Dist = "GG")
con_sam_lspace(LMoFit::FLOW_AMAX_MULT, type = "m", Dist = "BrIII")
con_sam_lspace(LMoFit::FLOW_AMAX_MULT, type = "m", Dist = "BrXII")
con_sam_lspace(LMoFit::FLOW_AMAX_MULT, type = "m", Dist = "GG")

# }