minor edits

EmilyMarkowitz-NOAA · Mar 8, 2021 · c920f15 · c920f15
1 parent fc6b3c9
commit c920f15
Show file tree

Hide file tree

Showing 10 changed files with 96 additions and 82 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,9 @@ devtools::install_github("EmilyMarkowitz-NOAA/NMFSReports")
 library(NMFSReports)
 ```
 
-## Use this package with `nmfspalette`: A package for NOAA Fisheries color schemes
+#### Use this package with `nmfspalette`
+
+A package for NOAA Fisheries color schemes
 
 ```r
 library(devtools)

diff --git a/docs/articles/A_use-buildReport.html b/docs/articles/A_use-buildReport.html
diff --git a/docs/articles/B_run-script-demo.html b/docs/articles/B_run-script-demo.html
diff --git a/docs/articles/C_functions-to-help-write-report.html b/docs/articles/C_functions-to-help-write-report.html
diff --git a/docs/articles/C_functions-to-help-write-report_files/figure-html/G1c-1.png b/docs/articles/C_functions-to-help-write-report_files/figure-html/G1c-1.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -5,7 +5,7 @@ articles:
   A_use-buildReport: A_use-buildReport.html
   B_run-script-demo: B_run-script-demo.html
   C_functions-to-help-write-report: C_functions-to-help-write-report.html
-last_built: 2021-03-08T18:19Z
+last_built: 2021-03-08T18:33Z
 urls:
   reference: https://emilymarkowitz-noaa.github.io/NMFSReports//reference
   article: https://emilymarkowitz-noaa.github.io/NMFSReports//articles

diff --git a/vignettes/A_use-buildReport.Rmd b/vignettes/A_use-buildReport.Rmd
@@ -31,15 +31,15 @@ To build your intitial architecture for your new NOAA Tech Memo or Report, simpl
 
   ## title
 
-  Default = "". Here, put the title of your report. You can change this later in the run file in needed.
+  Default = "". Here, put the title of your report. You can change this later in the `run.R` file in needed.
 
 ```{r}
 title = "My Awesome Report!"
 ```
 
 ## buildReport(author = ...)
 
-Here, add your First Lastname of everyone who is producing the report. You can change this later in the run file in needed.
+Here, add the first and last name of everyone who is producing the report. You can change this later in the `run.R` file in needed.
 
 ```{r}
 authors = "Me, Myself, and I"
@@ -49,7 +49,7 @@ authors = "Me, Myself, and I"
 
 Let's first think about what you want/need your Tech Memo to look like. For my purposes, I'll assume that you need the below sections:
 
-  ```{r}
+```{r}
 # list the sections (that you will have different rmd scripts for) in order and with no spaces
 sections <- c("frontmatter", # This is a specific template that matches the NOAA Template
               "abstract", # This, and all others unless otherwise mentioned, come from the same plain-slate document but are appropriately named and linked up in the 'run' file. 
@@ -83,9 +83,9 @@ Here's what they look like:
 
 Here's what they look like: 
 
-  ### refpptx_nmfs
-  
-  ![refpptx_nmfs](../man/figures/refpptx_nmfs.JPG)
+### refpptx_nmfs
+
+![refpptx_nmfs](../man/figures/refpptx_nmfs.JPG)
 
 ## buildReport(csl = ...)
 

diff --git a/vignettes/B_run-script-demo.Rmd b/vignettes/B_run-script-demo.Rmd
@@ -257,8 +257,7 @@ This is useful because your progress is saved each day that you work on this pro
 
 ![Output folder post running the run.R script](../man/figures/folder_output_post_run.JPG)
 
-
-# Notes: 
+# Notes:
 
 ## Support Scripts
 
@@ -274,18 +273,19 @@ To make sure we nice and neatly compartmentalize our work, the below supporting
 
 *data*: Where we will load that data kept locally that was either downloaded in "dataDL" or created locally. 
 
-# Things to change
+## Things to change
 
 Now that you have your initial run, you can start to modify and add to the structure with content specific to your project. Here are a few things to change: 
 
-## Metadata
+### Metadata
 
-Update the metadata to include your name, purpose, etc. 
+Update the metadata at the top of the page to include your name, purpose, etc. 
 
-# Knowns
+### Knowns
 
 Depending on the type of report, there may be things you want to define the report as a whole. If an annual report, a useful known to add there might be something like ` yr <- 2021 `
 
-# Sections
+### Sections
 
 Actually, what is written in this script is pretty customary and really shouldn't need to be changed unless you changed your mind about the organization of the report. Here, go into each of the .Rmd documents to edit them. 
+