README.md

gfplot: An R package for data extraction and plotting of British Columbia groundfish data

Travis-CI Build
Status

Facilitates the creation of an annual groundfish data synopsis report with gfsynopsis.

Note that the documentation is incomplete in some places. Please post in the issue tracker if you have questions or suggestions on how the package or its documentation could be improved. We welcome pull requests!

In addition to the help available through the R console, a web version of the documentation is available.

Installation

The gfplot package can be installed and loaded with:

# install.packages("devtools")
devtools::install_github("pbs-assess/gfplot")
library(gfplot)

Functions specific to PBS:

fns <- ls("package:gfplot")
sort(fns[grepl("get", fns)])
#>  [1] "get_age_methods"          "get_age_precision"       
#>  [3] "get_catch"                "get_commercial_samples"  
#>  [5] "get_cpue_historical"      "get_cpue_index"          
#>  [7] "get_cpue_spatial"         "get_cpue_spatial_ll"     
#>  [9] "get_fishery_ids"          "get_gear_types"          
#> [11] "get_hake_catch"           "get_major_areas"         
#> [13] "get_management"           "get_management_areas"    
#> [15] "get_other_surveys"        "get_sara_dat"            
#> [17] "get_sensor_attributes"    "get_sensor_data_fe_trawl"
#> [19] "get_sensor_data_ll_td"    "get_sensor_data_trawl"   
#> [21] "get_species"              "get_species_groups"      
#> [23] "get_ssids"                "get_survey_index"        
#> [25] "get_survey_samples"       "get_survey_sets"

Generic functions for any similarly formatted data:

sort(fns[grepl("tidy", fns)])
#>  [1] "tidy_age_precision"    "tidy_ages_raw"        
#>  [3] "tidy_ages_weighted"    "tidy_catch"           
#>  [5] "tidy_comps"            "tidy_comps_commercial"
#>  [7] "tidy_comps_survey"     "tidy_cpue_historical" 
#>  [9] "tidy_cpue_index"       "tidy_lengths_raw"     
#> [11] "tidy_lengths_weighted" "tidy_maturity_months" 
#> [13] "tidy_sample_avail"     "tidy_survey_index"    
#> [15] "tidy_survey_sets"
sort(fns[grepl("fit", fns)])
#> [1] "fit_cpue_index_glmmtmb" "fit_length_weight"     
#> [3] "fit_mat_ogive"          "fit_survey_sets"       
#> [5] "fit_vb"
sort(fns[grepl("plot", fns)])
#>  [1] "plot_age_precision"     "plot_ages"             
#>  [3] "plot_catch"             "plot_cpue_spatial"     
#>  [5] "plot_growth"            "plot_length_weight"    
#>  [7] "plot_lengths"           "plot_mat_ogive"        
#>  [9] "plot_maturity_months"   "plot_predictor_bubbles"
#> [11] "plot_qres_histogram"    "plot_qres_qq"          
#> [13] "plot_sample_avail"      "plot_survey_index"     
#> [15] "plot_survey_sets"       "plot_vb"


pbs-assess/gfplot documentation built on Sept. 17, 2019, 10:16 p.m.