Skip to contents

List the available models in a designated workspace.

e2e_ls.Rd

List the available models in a designated workspace.

Usage

e2e_ls(models.path = NULL)

Arguments

models.path

Relative path from the current working directory to a folder containing a library of model configurations (typically "Folder/Models"). Setting models.path="" is valid. Default models.path=NULL, meaning read a North Sea model setup from the package folder extdata/Models.

Value

An on-screen list of available models in the designated folder.

See also

e2e_copy, e2e_read

Examples

# List the models/variants supplied with the package:
    e2e_ls()
#> Current working directory is 'C:/Users/jackl/OneDrive - University of Strathclyde/Documents/Research/Packages/StrathE2E/strathe2e2/docs/reference'
#> List of package models in system folder "extdata/Models", with examples of how to read them:
#>  Model: "North_Sea"
#>   Variant: "1970-1999"	model <- e2e_read("North_Sea", "1970-1999")
#>   Variant: "2003-2013"	model <- e2e_read("North_Sea", "2003-2013")
#> 

# Dummy example to illustrate listing the models/variants in a user defined
# workspace. REPLACE "Folder1/Models" with your own models.path 
# remembering that this are relative to the current working directory.
#    e2e_ls("Folder/Models")