Skip to content

Commit

Permalink
satisfying r-devel checks
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanbeaudette committed Nov 18, 2023
1 parent 41a5688 commit 5486ba9
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 18 deletions.
4 changes: 2 additions & 2 deletions R/colorQuantiles.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
#'
#' @description Estimate central tendency and spread of soil color using marginal quantiles and L1 median of CIELAB coordinates.
#'
#' @details Colors are converted from sRGB to CIELAB (D65 illuminant), marginal quantiles of L,A,B coordinates are estimated, and L1 median {L,A,B} is estimates. The closest Munsell chips (via Munsell/CIELAB lookup table provided by \code{munsell}) and R colors are determined by locating chips closest to the marginal quantiles and L1 median.
#' @details Colors are converted from sRGB to CIELAB (D65 illuminant), marginal quantiles of (L,A,B) coordinates are estimated, and L1 median (L,A,B) is estimates. The closest Munsell chips (via Munsell/CIELAB lookup table provided by `munsell`) and R colors are determined by locating chips closest to the marginal quantiles and L1 median.
#'
#' The results can be conveniently inspected using \code{plotColorQuantiles}.
#' The results can be conveniently inspected using [plotColorQuantiles()].
#'
#' @author D.E. Beaudette
#'
Expand Down
4 changes: 2 additions & 2 deletions R/generalize.hz.R
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,9 @@ setMethod("generalizeHz", signature(x = "SoilProfileCollection"), function(x, ne
#' @description Convert a cross-tabulation: {original, genhz} to adjacency matrix.
#'
#' @param tab table, cross-tabulation of original and generalized horizon labels e.g. `table(original, genhz)`
#'
#' @return adjacency matrix
#' @author D.E. Beaudette
#' @export
#' @rdname hzTransitionProbabilities
genhzTableToAdjMat <- function(tab) {
tab <- as.matrix(tab)
# extract unique set of names
Expand Down
4 changes: 2 additions & 2 deletions R/hzTransitionProbabilities.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# generate transition probability matrix from horizon designations

#' @title Horizon Transition Probabilities
#'
#' @description Functions for creating and working with horizon (sequence) transition
Expand All @@ -9,7 +9,7 @@
#' * [horizon designation TP](http://ncss-tech.github.io/AQP/aqp/hz-transition-probabilities.html)
#' * [soil color TP](http://ncss-tech.github.io/AQP/aqp/series-color-TP-graph.html)
#'
#' @aliases hzTransitionProbabilities genhzTableToAdjMat mostLikelyHzSequence
#' @aliases hzTransitionProbabilities mostLikelyHzSequence
#'
#' @param x a `SoilProfileCollection` object.
#'
Expand Down
1 change: 1 addition & 0 deletions R/mostLikelyHzSequence.R
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ mostLikelyHzSequence <- function(mc, t0, maxIterations = 10) {
if(i > maxIterations)
break
}

return(s)
}

4 changes: 2 additions & 2 deletions man/colorQuantiles.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions man/genhzTableToAdjMat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 3 additions & 10 deletions man/hzTransitionProbabilities.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5486ba9

Please sign in to comment.