Skip to content

Wrapper for ASSAMC::run_om() to create example data #7

Description

@kellijohnson-NOAA

Is your feature request related to a problem? Please describe.
Need to easily and reproducibly create data from @Bai-Li-NOAA's operating model. Scripts are hard to maintain, share, and show people salient points of what they actually need to know, i.e., I want to hide a bunch of stuff in a function.

Describe the solution you'd like
I would like to be able to run one line of code to generate data from ASSAMC::run_om(). For example, ASSAMC::eg_omobject(), ASSAMC::example_omobject(), or something that clearly shows we are running an example.

Describe alternatives you've considered

  1. Keep code in a .R script that can be sourced.
  2. Source the relevant section of @Bai-Li-NOAA's README.md file using web-scraping techniques.
  3. Ask @Bai-Li-NOAA to parse out the code found in Useage to a separate file that can be sourced for her README and used here.
  4. We might be able to just have an example in @examples for ASSAMC::run_om() that could be sourced using example(ASSAMC::run_om)

@Bai-Li-NOAA let me know which alternative you prefer and I am happy to open a pull request from my fork or however you would like.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions