Skip to contents

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.

Examples

# View the MODEL_INFO file associated with the North Sea model embedded in the package:
    e2e_info_md()
#> Path to the model is: 'C:/Users/jackl/AppData/Local/Temp/Rtmp0GrtpA/temp_libpath850c45470c/StrathE2E2/extdata/Models'
#>  [1] "Model region      : North_Sea"                                                                                                                                       
#>  [2] "StrathE2E2 version: 4.0.1"                                                                                                                                           
#>  [3] ""                                                                                                                                                                    
#>  [4] "Model variant name: 1970-1999"                                                                                                                                       
#>  [5] "Release date      : 30-05-2022"                                                                                                                                      
#>  [6] "Implementation originally produced in the NERC Marine Ecosystem Programme (https://marine-ecosystems.org.uk/)"                                                       
#>  [7] "Driving data represent a climatological annual cycle for the period 1970-1999"                                                                                       
#>  [8] "Hydrodynamnic driving data from NEMO-ERSEM 7km model (https://www.uk-ssb.org/science_components/work_package_4/)"                                                    
#>  [9] "Nutrient driving data from ICES and BODC data archives and informed by NEMO-ERSEM"                                                                                   
#> [10] "Atmospheric driving data from EMEP (https://www.emep.int/)"                                                                                                          
#> [11] "River driving data from a statistical models of rainfall river flow and nutrent monitoring data (https://strathprints.strath.ac.uk/18588/6/strathprints018588.pdf)"  
#> [12] "Fishing data from ICES and STECF (https://www.ices.dk/data/dataset-collections/Pages/Fish-catch-and-stock-assessment.aspx and https://stecf.jrc.ec.europa.eu/dd/fdi)"
#> [13] "Setup parameters modified May 2022 to be consistent with StrathE2E 4.0.0"                                                                                            
#> [14] "Documentation: https://www.marineresourcemodelling.maths.strath.ac.uk/resources/StrathE2E2/documents/4.0.0/StrathE2E2_North_Sea_model.pdf"                           
#> [15] ""                                                                                                                                                                    
#> [16] "Model variant name: 2003-2013"                                                                                                                                       
#> [17] "Release date      : 30-05-2022"                                                                                                                                      
#> [18] "Implementation originally produced in the NERC Marine Ecosystem Programme (https://marine-ecosystems.org.uk/)"                                                       
#> [19] "Driving data represent a climatological annual cycle for the period 2003-2013"                                                                                       
#> [20] "Hydrodynamnic driving data from NEMO-ERSEM 7km model (https://www.uk-ssb.org/science_components/work_package_4/)"                                                    
#> [21] "Nutrient driving data from ICES and BODC data archives and informed by NEMO-ERSEM"                                                                                   
#> [22] "Atmospheric driving data from EMEP (https://www.emep.int/)"                                                                                                          
#> [23] "River driving data from a statistical models of rainfall river flow and nutrent monitoring data (https://strathprints.strath.ac.uk/18588/6/strathprints018588.pdf)"  
#> [24] "Fishing data from ICES and STECF (https://www.ices.dk/data/dataset-collections/Pages/Fish-catch-and-stock-assessment.aspx and https://stecf.jrc.ec.europa.eu/dd/fdi)"
#> [25] "Setup parameters modified May 2022 to be consistent with StrathE2E 4.0.0"                                                                                            
#> [26] "Documentation: https://www.marineresourcemodelling.maths.strath.ac.uk/resources/StrathE2E2/documents/4.0.0/StrathE2E2_North_Sea_model.pdf"                           
#> [27] ""                                                                                                                                                                    

    model_info <- e2e_info_md()
#> Path to the model is: 'C:/Users/jackl/AppData/Local/Temp/Rtmp0GrtpA/temp_libpath850c45470c/StrathE2E2/extdata/Models'
    model_info
#>  [1] "Model region      : North_Sea"                                                                                                                                       
#>  [2] "StrathE2E2 version: 4.0.1"                                                                                                                                           
#>  [3] ""                                                                                                                                                                    
#>  [4] "Model variant name: 1970-1999"                                                                                                                                       
#>  [5] "Release date      : 30-05-2022"                                                                                                                                      
#>  [6] "Implementation originally produced in the NERC Marine Ecosystem Programme (https://marine-ecosystems.org.uk/)"                                                       
#>  [7] "Driving data represent a climatological annual cycle for the period 1970-1999"                                                                                       
#>  [8] "Hydrodynamnic driving data from NEMO-ERSEM 7km model (https://www.uk-ssb.org/science_components/work_package_4/)"                                                    
#>  [9] "Nutrient driving data from ICES and BODC data archives and informed by NEMO-ERSEM"                                                                                   
#> [10] "Atmospheric driving data from EMEP (https://www.emep.int/)"                                                                                                          
#> [11] "River driving data from a statistical models of rainfall river flow and nutrent monitoring data (https://strathprints.strath.ac.uk/18588/6/strathprints018588.pdf)"  
#> [12] "Fishing data from ICES and STECF (https://www.ices.dk/data/dataset-collections/Pages/Fish-catch-and-stock-assessment.aspx and https://stecf.jrc.ec.europa.eu/dd/fdi)"
#> [13] "Setup parameters modified May 2022 to be consistent with StrathE2E 4.0.0"                                                                                            
#> [14] "Documentation: https://www.marineresourcemodelling.maths.strath.ac.uk/resources/StrathE2E2/documents/4.0.0/StrathE2E2_North_Sea_model.pdf"                           
#> [15] ""                                                                                                                                                                    
#> [16] "Model variant name: 2003-2013"                                                                                                                                       
#> [17] "Release date      : 30-05-2022"                                                                                                                                      
#> [18] "Implementation originally produced in the NERC Marine Ecosystem Programme (https://marine-ecosystems.org.uk/)"                                                       
#> [19] "Driving data represent a climatological annual cycle for the period 2003-2013"                                                                                       
#> [20] "Hydrodynamnic driving data from NEMO-ERSEM 7km model (https://www.uk-ssb.org/science_components/work_package_4/)"                                                    
#> [21] "Nutrient driving data from ICES and BODC data archives and informed by NEMO-ERSEM"                                                                                   
#> [22] "Atmospheric driving data from EMEP (https://www.emep.int/)"                                                                                                          
#> [23] "River driving data from a statistical models of rainfall river flow and nutrent monitoring data (https://strathprints.strath.ac.uk/18588/6/strathprints018588.pdf)"  
#> [24] "Fishing data from ICES and STECF (https://www.ices.dk/data/dataset-collections/Pages/Fish-catch-and-stock-assessment.aspx and https://stecf.jrc.ec.europa.eu/dd/fdi)"
#> [25] "Setup parameters modified May 2022 to be consistent with StrathE2E 4.0.0"                                                                                            
#> [26] "Documentation: https://www.marineresourcemodelling.maths.strath.ac.uk/resources/StrathE2E2/documents/4.0.0/StrathE2E2_North_Sea_model.pdf"                           
#> [27] ""                                                                                                                                                                    

# 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")