From 72fdba85abe0340f248cde76b39d4fd4bcf8afbf Mon Sep 17 00:00:00 2001 From: "Ben.Williams" Date: Wed, 1 Nov 2023 13:51:43 -0800 Subject: [PATCH] add intros --- README.Rmd | 18 +++++------------- README.md | 29 +++++++++++------------------ docs/articles/Catch-reports.html | 6 ++++-- docs/articles/Intros.html | 24 ++++++++++++++++++++++-- docs/index.html | 10 ++-------- docs/pkgdown.yml | 2 +- docs/reference/index.html | 10 +--------- docs/reference/nameit.html | 6 +++--- vignettes/Intros.Rmd | 14 ++++++++++++++ 9 files changed, 63 insertions(+), 56 deletions(-) diff --git a/README.Rmd b/README.Rmd index 0435da4..71e4362 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,7 +18,11 @@ knitr::opts_chunk$set( -The goal of planteam is to facilitate the development of the annual summary using .Rmd files to produce a word doc - that will likely be hosted on google docs for edits. +The goal of planteam is to facilitate the development of the annual SAFE summaries using .Rmd files to produce a word doc - that will likely be hosted on google docs for edits. +Additionally, this package can be used to generate catch reports (for off-cycle assessments) and the specs tables used by the AKRO. +Since all of these products are supposed to be pulling from the same data source this will hopefully eliminate copy & paste errors. + +See the [planteam webpage articles](https://afsc-assessments.github.io/planteam/) for more information. ## Installation @@ -29,15 +33,3 @@ You can install the development version of planteam from [GitHub](https://github devtools::install_github("afsc-assessments/planteam") ``` -## Example - -Once `planteam` is installed on your machine open a new .Rmd file, click on -the “From Template” find the one that is called `goa_summary`, or `bsai_summary` name it **goa_summary** or **bsai_summary** - *example links won't work otherwise* - and the suite of .Rmd files will be placed in the folder. - -```{r, echo=F} -knitr::include_graphics(here::here('man', 'figures', 'README-template.PNG')) -``` - -Go to either the `bsai_summary.Rmd` or `goa_summary.Rmd` file and press the `knit` button in Rstudio. -The specs data will be stored in the data folder, you will need both the September and Novemeber tables. -Additionally authors will need to fill in the biomass spreadsheet. diff --git a/README.md b/README.md index 185927d..f5b28a3 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,17 @@ -The goal of planteam is to facilitate the development of the annual -summary using .Rmd files to produce a word doc - that will likely be -hosted on google docs for edits. +The goal of planteam is to facilitate the development of the annual SAFE +summaries using .Rmd files to produce a word doc - that will likely be +hosted on google docs for edits. Additionally, this package can be used +to generate catch reports (for off-cycle assessments) and the specs +tables used by the AKRO. Since all of these products are supposed to be +pulling from the same data source this will hopefully eliminate copy & +paste errors. + +See the [planteam webpage +articles](https://afsc-assessments.github.io/planteam/) for more +information. ## Installation @@ -19,18 +27,3 @@ You can install the development version of planteam from # install.packages("devtools") devtools::install_github("afsc-assessments/planteam") ``` - -## Example - -Once `planteam` is installed on your machine open a new .Rmd file, click -on the “From Template” find the one that is called `goa_summary`, or -`bsai_summary` name it **goa_summary** or **bsai_summary** - *example -links won’t work otherwise* - and the suite of .Rmd files will be placed -in the folder. - - - -Go to either the `bsai_summary.Rmd` or `goa_summary.Rmd` file and press -the `knit` button in Rstudio. The specs data will be stored in the data -folder, you will need both the September and Novemeber tables. -Additionally authors will need to fill in the biomass spreadsheet. diff --git a/docs/articles/Catch-reports.html b/docs/articles/Catch-reports.html index 6e7e5fe..b6ef3f8 100644 --- a/docs/articles/Catch-reports.html +++ b/docs/articles/Catch-reports.html @@ -113,8 +113,8 @@

Catch-reports

Similarly a catch report for BSAI other rockfish would be entered as:

-      catch_report(title = "16. Assessment of the Other Rockfish stock complex in the Bering Sea/Aleutian Islands ",
-             authors = "Jane Sullivan, Matt Callahan, Andy Kingham, Todd TenBrink,  Ivonne Ortiz, Elizabeth Siddon, and Paul Spencer ",
+catch_report(title = "16. Assessment of the Other Rockfish stock complex in the Bering Sea/Aleutian Islands ",
+             authors = "Jane Sullivan, Matt Callahan, Andy Kingham, Todd TenBrink, Ivonne Ortiz, Elizabeth Siddon, and Paul Spencer ",
              stock = "orox",
              area = "BSAI",
              year = 2023,
@@ -122,6 +122,8 @@ 
Catch-reports

              next_full_year = 2024,
              catch_data_date = "November 5, 2023",
              output_dir = "2023")
+

If you have any problems please document them and post them as an +issue on github at: https://github.com/afsc-assessments/planteam/issues

+
+

Example +

+

Once planteam is installed on your machine open a new +.Rmd file, click on the “From Template” find the one that is called +goa_pt_summary, or bsai_pt_summary name it +goa_pt_summary or bsai_pt_summary - +example links won’t work otherwise - and a couple files will be +placed in the folder.

+

+

Go to either the bsai_pt_summary.Rmd or +goa_pt_summary.Rmd file and press the knit +button in Rstudio. The specs data will be stored in the data folder, you +will need make sure the data in the google +sheet are accurate.

+
+ + diff --git a/docs/index.html b/docs/index.html index b4e677e..91439ff 100644 --- a/docs/index.html +++ b/docs/index.html @@ -79,7 +79,8 @@ -

The goal of planteam is to facilitate the development of the annual summary using .Rmd files to produce a word doc - that will likely be hosted on google docs for edits.

+

The goal of planteam is to facilitate the development of the annual SAFE summaries using .Rmd files to produce a word doc - that will likely be hosted on google docs for edits. Additionally, this package can be used to generate catch reports (for off-cycle assessments) and the specs tables used by the AKRO. Since all of these products are supposed to be pulling from the same data source this will hopefully eliminate copy & paste errors.

+

See the planteam webpage articles for more information.

Installation

@@ -88,13 +89,6 @@

Installation# install.packages("devtools") devtools::install_github("afsc-assessments/planteam")

-
-

Example -

-

Once planteam is installed on your machine open a new .Rmd file, click on the “From Template” find the one that is called goa_summary, or bsai_summary name it goa_summary or bsai_summary - example links won’t work otherwise - and the suite of .Rmd files will be placed in the folder.

-

-

Go to either the bsai_summary.Rmd or goa_summary.Rmd file and press the knit button in Rstudio. The specs data will be stored in the data folder, you will need both the September and Novemeber tables. Additionally authors will need to fill in the biomass spreadsheet.

-
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 64c2141..fbe63b3 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -5,5 +5,5 @@ articles: Catch-reports: Catch-reports.html Intros: Intros.html Spec-tables: Spec-tables.html -last_built: 2023-11-01T21:24Z +last_built: 2023-11-01T21:44Z diff --git a/docs/reference/index.html b/docs/reference/index.html index 856984a..7d8dd0c 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -64,19 +64,11 @@

All functions

nameit()

-

age age plus group to biomass name

+

age plus group to biomass name

read_specs()

read in specs dataframe

- -

sum_tbl()

- -

spec table goa

- -

sum_tbl_bs()

- -

spec table bsai