Skip to content

Misleading documentation in generate.TP.fullgrids #33

@rplzzz

Description

@rplzzz
#' 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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions