rename_global_run: Rename global run

View source: R/user_interface.R

rename_global_runR Documentation

Rename global run

Description

Renames the files and directories , and meta data, of a global run of FPEM for a single marital group.

Usage

rename_global_run(
  run_name,
  new_run_name,
  output_folder_path = NULL,
  ignore = "^data$",
  verbose = FALSE
)

Arguments

run_name

Character. Name of run to be renamed.

new_run_name

Character. New run name.

output_folder_path

Filepath to directory where outputs are saved. If NULL, defaults to file.path("output", run_name).

ignore

Regular expression. Files and directories with names that match will not be renamed.

verbose

Logical; print lots and lots of messages about progress?

Value

Called for side effect only.

Note

If you modify ignore make sure ‘output_folder_path/data’ still matches; it is not a good idea to rename files in that directory.

Author(s)

Mark Wheldon


FPcounts/FPEMglobal documentation built on July 20, 2024, 2:35 a.m.