Example BGM Files for the Atlantis Ecosystem Model

A collection of box-geometry model (BGM) files for the Atlantis ecosystem model. Atlantis is a deterministic, biogeochemical, whole-of-ecosystem model (see < http://atlantis.cmar.csiro.au/> for more information).


Linux Build Status Windows Build Status CRAN_Status_Badge Coverage Status

BGM files for Atlantis

A raw-data package with example .bgm files (box geometry model) for Atlantis ecosystem model.

Atlantis is a deterministic, biogeochemical, whole-of-ecosystem model: http://atlantis.cmar.csiro.au/.

PLEASE NOTE: this is not an official source of BGM for use in Atlantis.

See https://github.com/mdsumner/rbgm for an R package to read these files and work with the box geometry.

See https://github.com/AustralianAntarcticDivision/box-geometry-models for the project that collects the files used in this package.

Installation

Install from CRAN:

install.packages("bgmfiles")

Install the develop version from Github using devtools.

devtools::install_github("AustralianAntarcticDivision/bgmfiles")

Usage

List the available raw files available in this package.

library(bgmfiles)
files <- bgmfiles()
print(basename(files))
#>  [1] "AEEC_poly_projETRS89_LAEA_snapped0p002.bgm"
#>  [2] "ams71.bgm"                                 
#>  [3] "antarctica_28.bgm"                         
#>  [4] "antarctica_99.bgm"                         
#>  [5] "CalCurrentV3_utm.bgm"                      
#>  [6] "Final_CAM_Boxes_8.bgm"                     
#>  [7] "GOM_BGM.bgm"                               
#>  [8] "Guam_utm1.bgm"                             
#>  [9] "JFRE_ll.bgm"                               
#> [10] "JFRE_xy.bgm"                               
#> [11] "NGOM.bgm"                                  
#> [12] "Nordic02.bgm"                              
#> [13] "VMPA_setas.bgm"

If needed filter based on a specific string with the pattern argument:

afiles <- bgmfiles(pattern = "^antarc")
print(basename(afiles))
#> [1] "antarctica_28.bgm" "antarctica_99.bgm"

This package exists as a data package to install example files, there is just one function bgmfiles that runs file finding functions:

list.files(system.file("extdata", package = "bgmfiles"), pattern = NULL, full.names = TRUE, recursive = TRUE)

We don't need to load or attach the package to find these files, but using the installation mechanism is very convenient for R use.

Contribute!

If you would like to contribute example BGM files or to the package:

or just get in touch directly via email.

News

bgmfiles 0.0.6

  • added added Final_CAM_Boxes_8.bgm from Thomas Ihde

  • updated install notes

bgmfiles 0.0.5

  • expanded description and added examples, thanks to CRAN

bgmfiles 0.0.4

  • new file NGOM.bgm from Cameron Ainsworth

  • new files JFRE_ll.bgm and JFRE_xy.bgm of the Juan Fernández Ridge Ecosystem (JFRE) from Javier Porobic

bgmfiles 0.0.3

  • new file CalCurrentV3_utm.bgm from Isaac Kaplan
  • new file Guam_utm1.bgm from Mariska Weijerman

bgmfiles 0.0.2

  • new file AEEC_poly_projETRS89_LAEA_snapped0p002.bgm from Raphaël Girardin
  • Added a function bgmfiles to do the work.
  • Added a NEWS.md file to track changes to the package.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("bgmfiles")

0.0.6 by Michael D. Sumner, 3 years ago


https://github.com/AustralianAntarcticDivision/bgmfiles/


Report a bug at https://github.com/AustralianAntarcticDivision/bgmfiles/issues/


Browse source code at https://github.com/cran/bgmfiles


Authors: Michael D. Sumner [aut, cre]


Documentation:   PDF Manual  


CC0 license


Suggests testthat, covr


Suggested by rbgm.


See at CRAN