SplitR (version 0.3)

dispersion_preset_delete: Remove dispersion preset information

Description

The function allows for the deletion of presets specific to dispersion runs. Presets are effectively blocks of parameters that are stored on the disk. The presets are divided into three groups: "emissions", "grids", and "species". Each preset has a plaintext file that resides on disk of the same name (located in the SplitR folder). This function by default runs in an interactive manner, prompting the user to select the preset to list from a condensed summary of presets of a given type. The function can also be called in a non-interactive manner, where specific presets of a type can be deleted without feedback. For adding presets to the associated files, the interactive function 'dispersion_preset_add()' can be used.

Usage

dispersion_preset_delete(read = NULL, numbers = NULL, interactive = TRUE,
  path_wd)

Arguments

read

the type of preset to delete. The three preset types are "emissions", "grids", and "species". Only a single type can be specified. If the argument for interactive remains TRUE (as in the default), the function will interactively prompt the user for the preset type if none is supplied. The preset must be supplied if the function is to be used in a non-interactive manner (futhermore, a single numeric value or numeric vector must be provided as the 'numbers' argument if 'interactive' is set to FALSE).

numbers

the values corresponding to the presets of a specified type (provided as the 'read' character argument) to be deleted. The argument is to be provided as a single numeric value or numeric vector. Any values provided for this argument will be ignored if 'interactive' is set to TRUE (the default). The numbers correspond to the order in which the presets appear in each of the 'emissions', 'grids', or 'species' plaintext files.

interactive

determines whether the function should run in an interactive mode, prompting the for input on which presets to delete. One-line summaries of presets for a specific type are presented to guide the user on which items are available for deletion. If the interactive mode is selected (it is the default mode), no values for the 'numbers' need to be supplied.

path_wd

a full path should be provided for the HYSPLIT working directory since presets will normally reside in this folder.

Examples

# NOT RUN {
# Delete an 'emissions' preset
dispersion_preset_delete("emissions")

# Delete a 'grids' preset
dispersion_preset_delete("grids")

# Delete a 'species' preset
dispersion_preset_delete("species")
# }