antaresEditObject (version 0.6.4)

backupStudy: Create a backup with an Antares Study

Description

Save an Antares Study or only inputs in a .tar.gz or .zip file

Usage

backupStudy(
  backupfile,
  what = "study",
  opts = antaresRead::simOptions(),
  extension = ".zip"
)

Value

The path of the backup

Arguments

backupfile

Name of the backup, without extension. If missing, either the name of the study or 'input' according argument what.

what

Which folder to save, input for the input folder or study for the whole study.

opts

List of simulation parameters returned by the function antaresRead::setSimulationPath

extension

Defaut is .zip.

Examples

if (FALSE) {
backupStudy()
}