bgmfiles: bgmfiles.

In bgmfiles: Example BGM Files for the Atlantis Ecosystem Model

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 [e-mail]

Other contributors:

• Hadley Wickham [contributor]

See Also

Useful links:

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

• Report bugs at https://github.com/AustralianAntarcticDivision/bgmfiles/issues/

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 = ""), ""))))

bgmfiles documentation built on Nov. 5, 2025, 7:14 p.m.