| Adds a column with a text version of flags for either non-retention or fishery scalers | add_flag_text |
| Check FRAM database after adding new stock | addstock_check |
| Extract AEQ mortality from Chinook FRAM database. Refactored and stripped down from the framr package written by Dan Auerbach. https://github.com/FRAMverse/framr/ | aeq_mortality |
| Performs error checks of a backwards FRAM run Returns nested tibble with diagnostics | bkfram_checks_coho |
| Changes a run's ID number in a FRAM database | change_run_id |
| *[Experimental]* Returns a tibble displaying predicted FRAMencounter mark rates by fishery, fishery type, and time-step. | coho_mark_rates |
| Compare tables in two equivalent FRAM databases | compare_databases |
| Compares the fishery flags of two runs | compare_fishery_input_flags |
| Compares the fishery inputs of two runs | compare_fishery_inputs |
| Generates a dataframe that compares fishery scalers table for two runs identified by run_id's | compare_inputs |
| Generates a heat map of changed between two run inputs. Can be a very busy chart if not filtered down. Consider using a filter. | compare_inputs_chart |
| Compares the non retention flags of two runs | compare_non_retention_input_flags |
| Compares the non retention inputs of two runs | compare_non_retention_inputs |
| Compares the recruit scalers of two runs | compare_recruits |
| Generates a report to the console of changes to inputs between two runs | compare_runs |
| Compares the stock fishery rate scalers of two runs | compare_stock_fishery_rate_scalers |
| This is a connection object to a FRAM database. Returns a list used throughout the rest of this package which carries meta data. | connect_fram_db |
| Experimental copying scaler inputs from one run to another DANGEROUS | copy_fishery_scalers |
| Safely disconnect from FRAM database | disconnect_fram_db |
| Check code for common errors | error_check_code |
| Creates quarto template files | fetch_quarto_templates |
| Fetches a complete table from a FRAM database. Returns a cleaned tibble. | fetch_table |
| Filters a dataframe to Alaska fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_ak |
| Filters a dataframe to Canadian (BC) fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_bc |
| Filters a dataframe to California fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_ca |
| Filters a dataframe to Coastal fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_coast |
| NA's all the information in the FisheryScalers that's not being used e.g Flag 1 only NS Scalers will be returned | filter_flag |
| Filters a dataframe to marine fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_marine |
| Filters a dataframe to net fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_net |
| Filters a dataframe to Oregon fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_or |
| Filters a dataframe to Puget Sound fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_puget_sound |
| Filters a dataframe to sport fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_sport |
| Filters a dataframe to Washington State fisheries. Will automatically detect whether it's working with a Chinook or Coho dataset if the tables were generated within this package. Requires a 'fishery_id' column name. | filter_wa |
| Finds tables that contain a specific column name | find_tables_by_column_ |
| Returns a tibble matching the Fishery Mortality screen. | fishery_mortality |
| Cleans the names of FRAM tables and coverts to a tibble | fram_clean_tables |
| Identifies the FRAM database species focus - Chinook or Coho | fram_database_species |
| Identifies the FRAM database type - Full or Transfer | fram_database_type |
| Gets all run_ids of FRAM database | get_run_ids |
| *[Experimental]* Initializes a FRAM project | initialize_project |
| Generates an input summary based on a FisheryScalers dataframe. Probably end up streamlining / revising this. | input_summary_ |
| Vectorized approach to calculating the management week, returns an integer | management_week |
| Guestimate the impact on a particular stock by multiplying its mortalities by the 'stock_mortality_ratio' produced by these functions. | mortality_scalers |
| Produces the MSF screen report numbers for encounters. Returns different format depending database. | msf_encounters |
| Returns a tibble matching the MSF screen report encounters for Chinook. This is specific for Chinook and in most cases msf_encounters() is preferable. | msf_encounters_chinook_ |
| Returns a tibble matching the MSF screen report encounters for Coho This is specific for Coho and in most cases msf_encounters() is preferable. | msf_encounters_coho_ |
| Produces the MSF screen report numbers for landed catch. Returns different format depending database. | msf_landed_catch |
| Returns a tibble matching the MSF screen report landed catch for Chinook. This is specific for Chinook and in most cases msf_landed_catch() is preferable. | msf_landed_catch_chinook_ |
| Returns a tibble matching the MSF screen report landed catch for Coho This is specific for Coho and in most cases msf_landed_catch() is preferable. | msf_landed_catch_coho_ |
| Produces the MSF screen report numbers for mortalities. Returns different format depending database. | msf_mortalities |
| Returns a tibble matching the MSF screen report mortalities for Chinook. This is specific for Chinook and in most cases msf_mortalities() is preferable. | msf_mortalities_chinook_ |
| Returns a tibble matching the MSF screen report mortalities for Coho This is specific for Coho and in most cases msf_mortalities() is preferable. | msf_mortalities_coho_ |
| Expand Chinook mortality table using Model-Stock Proportion | msp_mortality |
| Provides English translation of numeric non-retention flags | NR_flag_translate |
| Creates an ordered bar chart with the top number of mortalities per fishery. | plot_stock_mortality |
| Creates an ordered bar chart with the top number of mortalities per fishery and time step. | plot_stock_mortality_time_step |
| Returns a tibble matching the Population Statistics screen. | population_statistics |
| List names of FRAM table | provide_table_names |
| Removes a run in a FRAM database | remove_run |
| Provides a print out of Run ID information | run_info |
| Provides English translation of numeric scalers flags | scalers_flag_translate |
| Vectorized approach to calculating the statistical week, returns an integer | statistical_week |
| Helper function to check that all stock x age combinations are present | stock_age_checker |
| Helper function to check that stock id make sense | stock_check_helper |
| Helper function to check that stock id exist in the Stock database | stock_id_comp |
| Returns a tibble matching the Fishery Mortality screen. | stock_mortality |
| Framrsquared style guide | frs_stylecheck_assignment frs_stylecheck_snakecase styleguide |
| Returns a dataframe with fisheries defined by the TRuns report driver | truns_fisheries |
| Returns a dataframe with stocks defined by the TRuns report driver | truns_stocks |
| Convenience function to check fram_db input | validate_fram_db |
| Convenience function to check run_id input | validate_run_id |
| Welcome message, summarizing database information | welcome |
