diff --git a/docs/articles/development.html b/docs/articles/development.html index 0b41a2e..ba183f9 100644 --- a/docs/articles/development.html +++ b/docs/articles/development.html @@ -76,7 +76,7 @@

Development

-

2024-03-29

+

2024-08-29

diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html index 7ebdcb5..402c6d1 100644 --- a/docs/articles/getting-started.html +++ b/docs/articles/getting-started.html @@ -76,7 +76,7 @@

Getting started

-

2024-03-29

+

2024-08-29

diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 4df9971..d4dc2c8 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,9 +1,9 @@ -pandoc: 3.1.1 +pandoc: 3.1.11 pkgdown: 2.0.7 pkgdown_sha: ~ articles: development: development.html gap_check: gap_check.html getting-started: getting-started.html -last_built: 2024-03-29T16:48Z +last_built: 2024-08-29T16:20Z diff --git a/docs/reference/bsai_atf.html b/docs/reference/bsai_atf.html index 4b764bb..ed036fb 100644 --- a/docs/reference/bsai_atf.html +++ b/docs/reference/bsai_atf.html @@ -1,5 +1,5 @@ -raw data query for BSAI arrowtooth founder — bsai_atf • afscdataraw data query for BSAI arrowtooth flounder — bsai_atf • afscdata @@ -50,13 +50,13 @@
-

raw data query for BSAI arrowtooth founder

+

raw data query for BSAI arrowtooth flounder

-

raw data query for BSAI arrowtooth founder

+

raw data query for BSAI arrowtooth flounder

diff --git a/docs/reference/bsai_nrs.html b/docs/reference/bsai_nrs.html new file mode 100644 index 0000000..4313e19 --- /dev/null +++ b/docs/reference/bsai_nrs.html @@ -0,0 +1,112 @@ + +raw data query for BSAI northern rocksole — bsai_nrs • afscdata + + +
+
+ + + +
+
+
+

raw data query for BSAI northern rocksole

+ + +
+ +
+

raw data query for BSAI northern rocksole

+
+ +
+ 
bsai_nrs(year, off_yr = FALSE)
+
+ +
+

Arguments

+
year
+

assessment year

+ + +
off_yr
+

if this is an off-year assessment change to TRUE

+ +
+
+

Value

+ + +

a suite of raw data .csv files and a time stamp of when the query was done

+
+ +
+

Examples

+ 
if (FALSE) {
+bsai_atf(year = 2022, off_yr = FALSE)
+}
+
+
+ +
+ + +
+

Developed by Benjamin Williams.

+
+ +
+

Site built with pkgdown 2.0.7.

+
+ +
+ + + + + + + + diff --git a/docs/reference/index.html b/docs/reference/index.html index 8941bf0..49d723f 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -72,7 +72,7 @@

All functions

bsai_atf()

-

raw data query for BSAI arrowtooth founder

+

raw data query for BSAI arrowtooth flounder

bsai_fhs()

@@ -81,6 +81,10 @@

All functions bsai_fhs_catch_1964_1994

BSAI flathead sole historical catch data 1964-1994

+ +

bsai_nrs()

+ +

raw data query for BSAI northern rocksole

bsai_octopus()

@@ -264,6 +268,10 @@

All functions q_psc()

query prohibited species catch (psc) estimate

+ +

q_specs()

+ +

Query specs

saa_pop_60

diff --git a/docs/reference/q_catch.html b/docs/reference/q_catch.html index 099b5dc..f1d303a 100644 --- a/docs/reference/q_catch.html +++ b/docs/reference/q_catch.html @@ -1,6 +1,6 @@ query fishery catch data from AKFIN server — q_catch • afscdata @@ -58,7 +58,7 @@

query fishery catch data from AKFIN server

Note that this function produces results that may be confidential. -They can be hidden from git/GitHub by adding fsh_catch_data.csv to your .gitignore file

+They can be hidden from git/GitHub by adding fish_catch_data.csv to your .gitignore file

@@ -107,7 +107,7 @@

Arguments

Value

-

saves catch data as data/raw/fsh_catch_data.csv or outputs to the global environment, save also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

+

saves catch data as data/raw/fish_catch_data.csv or outputs to the global environment, save also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

diff --git a/docs/reference/q_fish_obs.html b/docs/reference/q_fish_obs.html index c85eb41..a298f00 100644 --- a/docs/reference/q_fish_obs.html +++ b/docs/reference/q_fish_obs.html @@ -93,7 +93,7 @@

Arguments

Value

-

saves observer data as data/raw/fsh_obs_data.csv or outputs to the global environment, save also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

+

saves observer data as data/raw/fish_obs_data.csv or outputs to the global environment, save also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

diff --git a/docs/reference/q_fsh_length.html b/docs/reference/q_fsh_length.html index f38ccff..766dae0 100644 --- a/docs/reference/q_fsh_length.html +++ b/docs/reference/q_fsh_length.html @@ -105,7 +105,7 @@

Arguments

Value

-

saves fishery length data as data/raw/fsh_length_data.csv or outputs to the global environment, also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

+

saves fishery length data as data/raw/fish_length_data.csv or outputs to the global environment, also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

diff --git a/docs/reference/q_fsh_specimen.html b/docs/reference/q_fsh_specimen.html index f83b8f2..f6905fe 100644 --- a/docs/reference/q_fsh_specimen.html +++ b/docs/reference/q_fsh_specimen.html @@ -105,7 +105,7 @@

Arguments

Value

-

saves fishery specimen data as data/raw/fsh_specimen_data.csv or outputs to the global environment, also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

+

saves fishery specimen data as data/raw/fish_specimen_data.csv or outputs to the global environment, also saves a copy of the SQL code used for the query and stores it in the data/sql folder.

diff --git a/docs/reference/q_specs.html b/docs/reference/q_specs.html new file mode 100644 index 0000000..9e938db --- /dev/null +++ b/docs/reference/q_specs.html @@ -0,0 +1,123 @@ + +Query specs — q_specs • afscdata + + +
+
+ + + +
+
+
+

Query specs

+ + +
+ +
+

Query specs

+
+ +
+ 
q_specs(year, species, area, db, print_sql = FALSE, save = TRUE)
+
+ +
+

Arguments

+
year
+

for specifying the correct folder

+ + +
species
+

species group code e.g., "DUSK", "PCOD"

+ + +
area
+

"GOA" or "BSAI"

+ + +
db
+

data server to connect to (akfin)

+ + +
print_sql
+

outputs the sql query instead of calling the data - save must be false

+ + +
save
+

saves a file to the data/raw folder, otherwise sends output to global enviro (default TRUE)

+ +
+ +
+

Examples

+ 
if (FALSE) {
+db = connect()
+q_specs(year=2024, species='PCOD', area='BSAI', db=db, save=F)
+}
+
+
+ +
+ + +
+

Developed by Benjamin Williams.

+
+ +
+

Site built with pkgdown 2.0.7.

+
+ +
+ + + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 76ca41b..d80882e 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -54,6 +54,9 @@ /reference/bsai_fhs_catch_1964_1994.html + + /reference/bsai_nrs.html + /reference/bsai_octopus.html @@ -198,6 +201,9 @@ /reference/q_psc.html + + /reference/q_specs.html + /reference/saa_pop_60.html