Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading documentation in generate.TP.fullgrids #33

Open
rplzzz opened this issue Nov 3, 2019 · 0 comments
Open

Misleading documentation in generate.TP.fullgrids #33

rplzzz opened this issue Nov 3, 2019 · 0 comments

Comments

@rplzzz
Copy link
Contributor

rplzzz commented Nov 3, 2019

#' This function takes in a trained emulator - a structure of class
#' \code{fldgen}.
#' This structure contains everything the emulator has learned about the model,
#' and is used to generate new fields of residuals. Also taking in a list of
#' generated residual fields and a global average yield, a global gridded
#' mean field is constructed accoring to the input reconstruction_function.
#' The mean field and residual fields are added to return a list of different
#' realizations of full fields.

This passage suggests that in this function we will be generating new residuals, but in fact the residuals have to be generated outside of the function and passed in. Also, the text could be clarified as to how the probability distribution transform is applied, and we should drop the reference to "yield", which is confusing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant