Title: Example BGM Files for the Atlantis Ecosystem Model
Version: 0.1.0
Description: 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).
License: CC0
RoxygenNote: 7.3.3
Suggests: testthat, covr
BugReports: https://github.com/AustralianAntarcticDivision/bgmfiles/issues/
URL: https://github.com/AustralianAntarcticDivision/bgmfiles/
Encoding: UTF-8
NeedsCompilation: no
Packaged: 2025-09-29 22:40:42 UTC; mdsumner
Author: Michael D. Sumner [aut, cre], Hadley Wickham [ctb]
Maintainer: Michael D. Sumner <mdsumner@gmail.com>
Repository: CRAN
Date/Publication: 2025-09-29 22:50:02 UTC

bgmfiles.

Description

Raw data files are maintained here: https://github.com/AustralianAntarcticDivision/box-geometry-models

Return the full paths to all files in the extdata/bgm/ folder of this package.

Usage

bgmfiles(pattern = NULL)

Arguments

pattern

optional pattern string to filter files returned, see list.files for details

Details

This package contains a simple workflow to update from that source repo and install the raw files into extdata/ of the installed package.

Value

character vector of file paths

Author(s)

Maintainer: Michael D. Sumner mdsumner@gmail.com

Other contributors:

See Also

Useful links:

Examples

## obtain all example files installed
bfiles <- bgmfiles()
print(basename(bfiles))

## filter based on an input pattern
afiles <- bgmfiles(pattern = "^antarc")
print(basename(afiles))

## read all the text from all files and table raw characters
## (for no reason)
lapply(bfiles, function(x) table(unlist(strsplit(paste(readLines(x), collapse = ""), ""))))