Skip to contents

Make a copy of a named model/variant and documentation in a user defined workspace

e2e_copy.Rd

Make a copy of a named model/variant and documentation in a user defined workspace

Usage

e2e_copy(model.name, model.variant, source.path = NULL, dest.path = NULL)

Arguments

model.name

Name of model to copy.

model.variant

Name of model variant to copy.

source.path

Relative path from the current working directory to the source model to be copied. Setting source.path="" is valid. Default source.path=NULL, meaning read a North Sea model setup from the package folder extdata/Models.

dest.path

Relative path from the current working directory to a destination address in which to create a 'Models' folder if necessary, and then copy the model files. Setting dest.path="" is valid. Default dest.path=NULL in which case the Models folder will be created in a temporary directory.

Value

A copy of an entire model/variant and the associated documentation folder in the designated workspace.

See also

e2e_ls, e2e_read

Examples

# Copy the 2003-2013 version of the North Sea model supplied with the package into a
# temporary folder: 
    e2e_copy("North_Sea", "2003-2013")
#> Current working directory is 'C:/Users/jackl/OneDrive - University of Strathclyde/Documents/Research/Packages/StrathE2E/strathe2e2/docs/reference'
#> No 'dest.path' specified so the copied model files
#> will be directed to the temporary directory...
#> 'C:\Users\jackl\AppData\Local\Temp\RtmpYdRhoX'
#> 
#>  Copying model: 'North_Sea, variant '2003-2013':
#>   from 'C:/Users/jackl/AppData/Local/Temp/Rtmp0GrtpA/temp_libpath850c45470c/StrathE2E2/extdata/Models/North_Sea/2003-2013'
#>   to   'C:\Users\jackl\AppData\Local\Temp\RtmpYdRhoX/Models/North_Sea/2003-2013'

# Dummy example illustrating copy the 2003-2013 version of the North Sea model 
# supplied with the package into a user-defined folder (edit "Folder/Models to 
# your own relative path): 
#   e2e_copy("North_Sea", "2003-2013",dest.path="Folder/Models")

# Dummy example illustrating copying a user model into a user workspace:
# Replace "Folder1/Models" and "Folder2/Models" with your own source.path and dest.path
# remembering that these are relative to the current working directory.
# e.g.... e2e_copy("Modelname", "Modelvariant",
#         source.path="Folder1/Models",
#         dest.path="Folder2/Models")