change package name to stockplotr (#50)

* change package name

* Added units to plots that can produce relative values (#49)

* Added units to plots that can produce relative values (biomass, recruitment, and spawning biomass) as per #44

* Added new arg to add_more_key_quants to allow for values to be scaled; updated fxns with this arg (plot_biomass, recruitment, ssb); moved code that computes min/max B, R, ssb from write_captions to add_more_key_quants; updated add_more_key_quants to label scaled values with appropriate label that's inclusive of scale's order of magnitude

* Added code that adds new key quantities extracted in add_more_key_quants into captions/alt text csv; updated exp_all_figs_tables to include new arguments specifying scaling amounts for biomass, recruitment, and sp biomass plots

* Fix test

* Update documentation for exp_all_figs_tables

* Attempt to fix test failures by fixing path in add_more_key_quants()

* add dat arg to B, R, SSB plotting fxns, and add_more_key_quants, to address failing tests

* Updates per Schiano-NOAA's comments on PR (minor edits to code, documentation)

* add warning for previous naming

* add callout box for name change

---------

Co-authored-by: Sophie Breitbart <[email protected]>

DESCRIPTION

@@ -1,6 +1,6 @@
-Package: satf
+Package: stockplotr
 Type: Package
-Title: Stock Assessment Tables and Figures
+Title: Tables and Figures for Stock Assessments
 Version: 0.1.0
 Author: Samantha Schiano, Bai Li, Steve Saul, Kelli F. Johnson, & Megumi Oshima
 Maintainer: Samantha Schiano <[email protected]>

README.md

@@ -1,41 +1,45 @@
-# Stock Assessment Tables and Figures (satf)
+# stockplotr
 
 <!-- badges: start -->
 <!-- badges: end -->
 
-The goal of satf is to create a centralized package that contains all of the figures and tables that are used when analyzing stock assessment model outputs, writing a report, and other various procedures performed during the stock assessment workflow. There are multiple current packages that perform a similar function, but they are typically region and/or model dependent. Across the US, there are multiple packages that create plots that are directly used in a stock assessment report used for management. For example, an analyst that uses Stock Synthesis (SS3) to assess a stock will utilize [`r4ss`](https://github.com/r4ss/r4ss/), a package that reads outputs, plots key parameters, and more to increase throughput and reduce tedious tasks for an analyst.
+::: {.callout-note}
+***Previously named 'satf'***
+:::
+
+The goal of stockplotr is to create a centralized package that contains all of the figures and tables that are used when analyzing stock assessment model outputs, writing a report, and other various procedures performed during the stock assessment workflow. There are multiple current packages that perform a similar function, but they are typically region and/or model dependent. Across the US, there are multiple packages that create plots that are directly used in a stock assessment report used for management. For example, an analyst that uses Stock Synthesis (SS3) to assess a stock will utilize [`r4ss`](https://github.com/r4ss/r4ss/), a package that reads outputs, plots key parameters, and more to increase throughput and reduce tedious tasks for an analyst.
 
 Please note that this package is still in development. As such, some functions are still in development, such as the functions that create indices figures (i.e., `plot_indices`) and landings tables (i.e., `table_landings`).
 
 ## Installation
 
-You can install the development version of satf from [GitHub](https://github.com/) with:
+You can install the development version of stockplotr from [GitHub](https://github.com/) with:
 
 ``` r
 # install.packages("devtools")
-devtools::install_github("nmfs-ost/satf")
+devtools::install_github("nmfs-ost/stockplotr")
 ```
 
-Alternatively, you can install satf using the `remotes` package:
+Alternatively, you can install stockplotr using the `remotes` package:
 
 ```r
 install.packages("remotes")
-remotes::install_github("nmfs-ost/satf")
+remotes::install_github("nmfs-ost/stockplotr")
 ```
 
 Occassionally, the package can not be installed using the `remotes` package. If this is the case for you and the other two installation options don't work please try:
 
 ```r
 install.packages("pak")
-pak::pak("nmfs-ost/satf")
+pak::pak("nmfs-ost/stockplotr")
 ```
 
 ## Example
 
 This is a basic example which shows you how to solve a common problem:
 
 ``` r
-library(satf)
+library(stockplotr)
 ## basic example code
 ```