Doc update

SantanderMetGroup · Oct 17, 2018 · aa373af · aa373af
1 parent c295efe
commit aa373af
Show file tree

Hide file tree

Showing 12 changed files with 339 additions and 8 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -3,6 +3,7 @@
 export(MrQuantile)
 export(QuantileProbs)
 export(bubblePlot)
+export(cascadePlot)
 export(clim2sgdf)
 export(climagram)
 export(detrend.data)

diff --git a/R/cascadePlot.R b/R/cascadePlot.R
@@ -29,7 +29,7 @@
 #'   If NULL (default) names are taken from x.
 #' @param colors Color vector to be used in the last aggregating step and all 
 #'   lines leading to each main branch. If NULL (default) an appropriate rainbow 
-#'   scale is used. Its length should be length(levels(factors[[rev(stages)[1]]])).
+#'   scale is used. Its length should be \code{length(levels(factors[[rev(stages)[1]]]))}.
 #' @param title Title of the plot
 #' @param line.width Width of the lines.
 #' @param plot.density Logical (default = TRUE). Add an estimate of the probability

diff --git a/R/side.density.R b/R/side.density.R
@@ -9,7 +9,7 @@
 #'   Alpha ranges from 0 (fully transparent) to 1 (opaque). Default is 0.3. 
 #' @param shades Logical (default = FALSE). If TRUE add shades for the quantiles 
 #'   defined in prob.
-#' @param prob A vector giving the quantiles to be highlithed in the PDF. 
+#' @param prob A vector giving the quantiles to be highlighted in the PDF. 
 #'   Default is the quartiles.
 #' @param density.offset A vector indicating how much the PDF should be shifted 
 #'   relative to the bottom part of the plot. Default is 0.

diff --git a/man/bubblePlot.Rd b/man/bubblePlot.Rd
diff --git a/man/cascadePlot.Rd b/man/cascadePlot.Rd
diff --git a/man/climagram.Rd b/man/climagram.Rd
diff --git a/man/reliabilityCategories.Rd b/man/reliabilityCategories.Rd
diff --git a/man/side.density.Rd b/man/side.density.Rd
diff --git a/man/spreadPlot.Rd b/man/spreadPlot.Rd
diff --git a/man/tercileBarplot.Rd b/man/tercileBarplot.Rd
diff --git a/man/tercilePlot.Rd b/man/tercilePlot.Rd