e2e_info_md {StrathE2E2} | R Documentation

## List the available models in a designated workspace.

### Description

List the available models in a designated workspace.

### Usage

    e2e_info_md(models.path = NULL, model.name = "North_Sea")

### 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.
`model.name` | Name of model to read. Setting models.name="" is valid. Default model.path="North_Sea", meaning read the North Sea model info from the package folder extdata/Models.

### Value

A text object containing the MODEL_INFO data associated with the selected model region.

### See Also

`e2e_ls` , `e2e_copy`, `e2e_read` , `e2e_info_pk`

### Examples

    # View the MODEL_INFO file associated with the North Sea model embedded in the package:
        e2e_info_md()

        model_info <- e2e_info_md()
        model_info

    # Dummy example to illustrate listing the models/variants in a user defined
    # workspace. REPLACE "Folder/Models" and "Model.Name" with your own models.path and model.name
    # remembering that the folder is relative to the current working directory.
    #    e2e_info_md("Folder/Models","Model.Name")

[Package StrathE2E2 version 4.0.0 Index]