JGCRI / an2month

Use CMIP 5 data to approximate monthly data from annual data.
0 stars 0 forks source link

Correct the documentation of function `monthly_downscaling` #18

Open abigailsnyder opened 4 years ago

abigailsnyder commented 4 years ago

Documentation says the input alpha to the function monthly_downscaling should be

#' @param alpha Matrix[ngrid, 12] of the alpha parameters for the Dirichlet
#' distribution.  These values are included as package data.  For more details
#' on how they are calculated see data-raw.

But the code is actually expecting alpha to be a list, one entry of which is that matrix (under the appropriate variable name).

Will probably address this under the PR for https://github.com/JGCRI/an2month/issues/16, and will just add any other additional documentation corrections that come up here.