man-roxygen/file_out.R

In r4atlantis/atlantisom: Generates Data Sets From Atlantis Scenarios

#' @param file_out A character value specifying a file name to write
#'   output to. If the function takes the argument \code{dir}, then
#'   the file will be written to \code{file.path(dir, file_out)}. If the
#'   argument \code{dir} is not included in the function then the file will
#'   be written to the current directory or one can specify a full path name.
#'   The default will depend on the function and if \code{is.null(file_out)}
#'   then no file will be written.