Skip to content

Commit

Permalink
change package name
Browse files Browse the repository at this point in the history
  • Loading branch information
Schiano-NOAA committed Feb 24, 2025
1 parent b25112e commit 95e7bc7
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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]>
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
# 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.
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
```

Expand Down
File renamed without changes.

0 comments on commit 95e7bc7

Please sign in to comment.