From 4c9096bddc002328882eb23b11a4e961ea87c14c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=B6ley?= Date: Fri, 19 Jan 2024 10:07:25 +0100 Subject: [PATCH] Update Documentation --- man/ColorMapSextant.Rd | 4 ++-- man/ColorMapTricolore.Rd | 4 ++-- man/TernaryCenterGrid.Rd | 2 +- man/TernaryDistance.Rd | 4 ++-- man/TernaryLimits.Rd | 2 +- man/TernaryNearest.Rd | 2 +- man/TernarySextantVertices.Rd | 2 +- man/TernarySurroundingSextant.Rd | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/man/ColorMapSextant.Rd b/man/ColorMapSextant.Rd index cb71d50..7fc3433 100755 --- a/man/ColorMapSextant.Rd +++ b/man/ColorMapSextant.Rd @@ -7,7 +7,7 @@ ColorMapSextant(P, center, values) } \arguments{ -\item{P}{n by 3 matrix of ternary compositions {p1, p2, p3}_i for +\item{P}{n by 3 matrix of ternary compositions [p1, p2, p3](i) for i=1, ..., n.} \item{center}{Ternary coordinates of the sextant meeting point.} @@ -16,7 +16,7 @@ i=1, ..., n.} } \value{ An n row data frame giving, for each row of the input P, the input -proportions (p1, p2, p3), sextant id (sextant) and the hex-rgb string of the +proportions [p1, p2, p3], sextant id (sextant) and the hex-rgb string of the mixed colors (rgb). } \description{ diff --git a/man/ColorMapTricolore.Rd b/man/ColorMapTricolore.Rd index 19f440c..a13bc4b 100755 --- a/man/ColorMapTricolore.Rd +++ b/man/ColorMapTricolore.Rd @@ -7,7 +7,7 @@ ColorMapTricolore(P, center, breaks, h_, c_, l_, contrast, spread) } \arguments{ -\item{P}{n by 3 matrix of ternary compositions {p1, p2, p3}_i for +\item{P}{n by 3 matrix of ternary compositions [p1, p2, p3](i) for i=1, ..., n.} \item{center}{Ternary coordinates of the grey-point.} @@ -27,7 +27,7 @@ Values above 99 imply no discretization.} } \value{ An n row data frame giving, for each row of the input P, the input -proportions (p1, p2, p3), parameters of the color mixture (h, c, l) and the +proportions [p1, p2, p3], parameters of the color mixture (h, c, l) and the hex-rgb string of the mixed colors (rgb). } \description{ diff --git a/man/TernaryCenterGrid.Rd b/man/TernaryCenterGrid.Rd index 81b9923..683245e 100755 --- a/man/TernaryCenterGrid.Rd +++ b/man/TernaryCenterGrid.Rd @@ -8,7 +8,7 @@ TernaryCenterGrid(center, spacing) } \arguments{ \item{center}{The center of the grid. -A vector of ternary coordinates {p1, p2, p3}.} +A vector of ternary coordinates [p1, p2, p3].} \item{spacing}{The spacing of the grid in percent-point increments. A numeric > 0.} diff --git a/man/TernaryDistance.Rd b/man/TernaryDistance.Rd index a9dec68..8182f41 100755 --- a/man/TernaryDistance.Rd +++ b/man/TernaryDistance.Rd @@ -7,9 +7,9 @@ TernaryDistance(p, C) } \arguments{ -\item{p}{A vector of ternary coordinates {p1, p2, p3}.} +\item{p}{A vector of ternary coordinates [p1, p2, p3].} -\item{C}{n by 3 matrix of ternary coordinates {p1, p2, p3}_i for i=1,...,n.} +\item{C}{n by 3 matrix of ternary coordinates [p1, p2, p3](i) for i=1,...,n.} } \value{ A numeric vector of distances between coordinate p and all diff --git a/man/TernaryLimits.Rd b/man/TernaryLimits.Rd index b4ce4f4..2732005 100755 --- a/man/TernaryLimits.Rd +++ b/man/TernaryLimits.Rd @@ -7,7 +7,7 @@ TernaryLimits(P, na.rm = TRUE) } \arguments{ -\item{P}{n by 3 matrix of ternary coordinates {p1, p2, p3}_i for +\item{P}{n by 3 matrix of ternary coordinates [p1, p2, p3](i) for i=1,...,n.} \item{na.rm}{Should NAs be removed? (default=TRUE)} diff --git a/man/TernaryNearest.Rd b/man/TernaryNearest.Rd index fccdf81..b96e727 100755 --- a/man/TernaryNearest.Rd +++ b/man/TernaryNearest.Rd @@ -7,7 +7,7 @@ TernaryNearest(P, C) } \arguments{ -\item{P, C}{n by 3 matrix of ternary coordinates {p1, p2, p3}_i for +\item{P, C}{n by 3 matrix of ternary coordinates [p1, p2, p3](i) for i=1,...,n. n may be different for P and C.} } \value{ diff --git a/man/TernarySextantVertices.Rd b/man/TernarySextantVertices.Rd index 5649f28..ff841f4 100755 --- a/man/TernarySextantVertices.Rd +++ b/man/TernarySextantVertices.Rd @@ -8,7 +8,7 @@ TernarySextantVertices(center) } \arguments{ \item{center}{The sextant center. -A vector of ternary coordinates {p1, p2, p3}.} +A vector of ternary coordinates [p1, p2, p3].} } \value{ Index, vertex id and barycentric vertex coordinates for each of the diff --git a/man/TernarySurroundingSextant.Rd b/man/TernarySurroundingSextant.Rd index aa7d07b..2b4a371 100755 --- a/man/TernarySurroundingSextant.Rd +++ b/man/TernarySurroundingSextant.Rd @@ -7,11 +7,11 @@ TernarySurroundingSextant(P, center) } \arguments{ -\item{P}{n by 3 matrix of ternary coordinates {p1, p2, p3}_i for +\item{P}{n by 3 matrix of ternary coordinates [p1, p2, p3](i) for i=1,...,n.} \item{center}{The sextant center. -A vector of ternary coordinates {p1, p2, p3}.} +A vector of ternary coordinates [p1, p2, p3].} } \value{ An n element character vector of sextant id's 1 to 6.