add intros

afsc-assessments · Nov 1, 2023 · 72fdba8 · 72fdba8
1 parent 5945428
commit 72fdba8
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 56 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -18,7 +18,11 @@ knitr::opts_chunk$set(
 <!-- badges: start -->
 <!-- badges: end -->
 
-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
@@ -6,9 +6,17 @@
 <!-- badges: start -->
 <!-- badges: end -->
 
-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.
-
-<img src="man/figures/README-template.PNG" width="100%" />
-
-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
diff --git a/docs/articles/Intros.html b/docs/articles/Intros.html
diff --git a/docs/index.html b/docs/index.html
diff --git 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
diff --git a/docs/reference/nameit.html b/docs/reference/nameit.html
diff --git a/vignettes/Intros.Rmd b/vignettes/Intros.Rmd
@@ -15,5 +15,19 @@ knitr::opts_chunk$set(
 ```
 
 ```{r setup}
+# install.packages('devtools')
+# install.github('afsc-assessments/planteam)
 library(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_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. 
+
+```{r, echo=F}
+knitr::include_graphics(here::here('man', 'figures', 'README-template.PNG'))
+```
+
+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](https://docs.google.com/spreadsheets/d/1uHmCuY3GXfSBCbsP61nAQeATBfoslXeS3PQNLlioWIk/edit#gid=1812144961) are accurate.