CSHS-CWRA / CSHShydRology

Main package
GNU Affero General Public License v3.0
35 stars 39 forks source link

Added ch_col_transparent plus Minor documentation updates #90

Closed rchlumsk closed 2 years ago

rchlumsk commented 2 years ago
KevinShook commented 2 years ago

Looks good. I might suggest a couple of changes in the documentation, to capitalise the parameter descriptions and make them a bit clearer Currently it reads:

#' ch_col_transparent is used to adjust colour codes to introduce transparency
#'
#' @param colour time series containing columns you wish to reseasonalize. xts
#' object
#' @param trans integer describing the degree of transparency, from ~200
#' (slightly transparent) to <10 (very transparent)`t)

Could be changed to:

#' Adjusts colour codes to introduce transparency. Useful for base graphing.
#'
#' @param colour An \pkg{xts} time series object containing columns you wish to reseasonalize.
#' @param trans Integer describing the degree of transparency, from ~200
#' (slightly transparent) to <10 (very transparent)
rchlumsk commented 2 years ago

Thanks for the suggestion, Kevin. I realized the description involving xts was not relevant, must have been a leftover copy+paste. It just takes a vector of colours and a vector of transparency levels (integers). See update!

KevinShook commented 2 years ago

Much better.