Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Developer Issue]: wrapper function to run a FIMS model #621

Open
8 tasks
kellijohnson-NOAA opened this issue Jun 5, 2024 · 2 comments
Open
8 tasks

[Developer Issue]: wrapper function to run a FIMS model #621

kellijohnson-NOAA opened this issue Jun 5, 2024 · 2 comments
Assignees
Labels
kind: feature New feature or request P2 mid-level priority theme: R interface
Milestone

Comments

@kellijohnson-NOAA
Copy link
Contributor

kellijohnson-NOAA commented Jun 5, 2024

Issue details

It would be nice to have a single function to run a FIMS model where everything is ran in an environment inside the wrapper function so your working environment is not polluted and you do not have to make multiple calls to non-FIMS functions, i.e., MakeADFun() and optim(). This wrapper function will help make FIMS more accessible to non-power users. Good examples exist in {sdmTMB} and {glmmTMB}. This topic is touched on in the following issues

The timeline for the development of this R function is still underway but research is currently being conducted.

  • Research what other packages do
  • Implement a skeleton function
  • Finish the function
  • Present the function in a seaside chat during any point of development for feedback
  • Write tests
  • Document the function
  • Update the vignette and case-studies (but maybe leave an example of how a power user would do it in so there are examples of all avenues), feel free to open an issue in the case studies repo and assign someone to modify the case study code to use the new function
  • close associated issues (see above) that pertain to this function if they are finished

Notes for the development of this function can be found here on Google Drive.

@Andrea-Havron-NOAA
Copy link
Collaborator

The Kristensen et al. 2016 paper performed a comparison between optim and nlminb and found nlminb to be more stable and faster.

@Bai-Li-NOAA
Copy link
Contributor

Thanks @Andrea-Havron-NOAA, we will use nlminb in the wrapper function as suggested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: feature New feature or request P2 mid-level priority theme: R interface
Projects
Status: No status
Development

No branches or pull requests

4 participants