R/choose_output.R

In pschmidtwalter/brook90r: Run the LWF-Brook90 hydrological model from within R.

#' Select output for LWF-Brook90
#'
#' Opens the data editor with a [5,10] matrix for selecting the LWF-Brook90-output
#' by flagging cells with 1. Assign a name to the returned matrix and use it as
#' 'outputmat'-argument in \code{\link{Run.B90}}. A default output-matrix is returned
#' without opening the data-editor when edit = FALSE.
#'
#' @param outputmat optional [5,10]-matrix, opened for editing.
#' If no matrix is passed, a default selection of output values is opened in R's data-editor or returned
#' instantly, if edit=FALSE.
#' @param edit open R's data-editor ?
#'
#' @return a [5,10]-matrix containing 0 and 1 for use as 'outputmat'-argument in \code{\link{Run.B90}}
#' @examples
#'
#' # opens data editor with default selection
#'outmat <- choose_output.B90()
#'
# modify
#'outmat[6,] <- 1
#'
# open modified
#'outmat_new <- choose_output.B90(outmat)
#'
# create default matrix without editing
#'outmat <- choose_output.B90(edit = F)
#'
#' @export
choose_output.B90 <- function(outputmat = NULL,
                              edit = T) {
  if (is.null(outputmat)) {
    outputmat <- matrix(ncol = 5,nrow = 10,
                        byrow = TRUE,
                        dimnames = list(c("'Eval'", "'Budg'","'Flow'","'Evap'","'Abov'","'Belo'","'Swat'","'Psit'","'Misc'","'User'"),
                                        c("Ann","Mon","Day","Pre","ITR")),
                        #     #Year, Month, Day, PInt Itr #Achtung Itr gibt keinen Output! NIcht w?hlen
                        data = c(0,    0,     0,   0,   0, #Eval
                                 0,    0,     0,   0,   0, #Budg
                                 0,    0,     0,   0,   0, #Flow
                                 1,    1,     1,   0,   0, #Evap
                                 0,    0,     0,   0,   0, #Abov
                                 0,    0,     0,   0,   0, #Belo
                                 0,    0,     1,   0,   0, #Swat
                                 0,    0,     0,   0,   0, #Psit
                                 0,    0,     0,   0,   0, #Misc
                                 0,    0,     0,   0,   0  #User
                        )
    )
    if (edit == T) {
      outputmat <- edit(outputmat)}
  } else {
    if (all(dim(outputmat) == c(10,5)) ) {
      outputmat <- edit(outputmat)
    }
    else {
      stop("Please provide a [10,5] matrix for editing!")
    }
  }
  outputmat[which(outputmat != 0)] <- 1
  outputmat
}