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.

Sign up for GitHub

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

Jump to bottom

Documentation: adjustments.r functions #116

Merged
merged 7 commits into from
Feb 27, 2025
Merged

Documentation: adjustments.r functions #116

merged 7 commits into from
Feb 27, 2025

Conversation

andybeet
Copy link
Member

@andybeet andybeet commented Feb 25, 2025 •
edited
Loading

File changed

  • Adjustments.r

Functions documented

uses Anchovy bay (AB.params) as example ecosystem

  • adjust.fishing
  • adjust.forcing
  • adjust.scenario
  • frate.table
  • set.rsim.scene
  • get.rsim.params
  • get.rsim.start_state
  • get.rsim.forcing
  • get.rsim.fishing
  • get.rsim.stanzas

Details

  • Updated the title and description
  • Created autolinks to other functions mentioned in the documentation
  • Expanded explanation of object output (how many variables in the list, their names, and definitions)
  • Created an example of how you would use this function using the anchovy bay bundled rpath models

@andybeet andybeet changed the title documentation for adjustments.r functions Documentation: adjustments.r functions Feb 25, 2025
@andybeet
Copy link
Member Author

i think as a second pass at documentation we may want to reorganize how functions are listed in the reference page.

kaydin
kaydin approved these changes Feb 25, 2025
View reviewed changes
Copy link
Collaborator

@kaydin kaydin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to move to review of whole package

@andybeet andybeet mentioned this pull request Feb 25, 2025
Open
15 tasks
SarahJWeisberg
SarahJWeisberg reviewed Feb 26, 2025
View reviewed changes
@andybeet
changed examples comments in all functions
f7172d1 
- rpath scenario to rsim scenario
- balance model to generate balanced model
@kaydin kaydin merged commit b4e83af into docs_pre_release Feb 27, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SarahJWeisberg SarahJWeisberg SarahJWeisberg left review comments

@kaydin kaydin kaydin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@andybeet @kaydin @SarahJWeisberg