Man pages for pbs-assess/gfiscamutils
Provide functions for iSCAM models

autocorr_plotAn extended version of 'coda::autocorr.plot()'
batmanCall the Batman
calc_beta_mean_cvCalculate the mean and CV for a Beta distribution given the...
calc_beta_paramsCalculate the shape parameters (alpha and beta) for a Beta...
calc_logsCalculate logs for several parameters using MCMC
calc_longer_quantsCalculate age fits / age residuals and selectivity estimates...
calc_mcmcPerform some quantile calculations on the MCMC posteriors
calc_mpd_logsCalculate logs for several parameters using MPD
calc_probs_biomassCalculate the probabilities that biomasses are under or over...
calc_quantilesCalculate and insert columns containing arbitrary quantiles...
calc_rho_varthetaCalculation of rho and vartheta from sigma and tau
calc_sig_tauCalculation of sigma and tau from rho and vartheta
c.model.listDeprecated Extract the model class objects from the list of...
convert_prob_cols_languageConvert any columns in a data frame that appear as 22.5% (for...
create_rds_fileCreate an rds file to hold the model's data and outputs.
delete_files_extDelete all files with a specific extension recursively. By...
dos.append.to.logThe DOS append to log operator string
dos.pipe.to.logThe DOS pipe to log operator string
extract_age_outputExtract an age structure MPD object from iSCAM output (.rep...
extract_area_sex_matricesExtract the given data frame into a list of matrices by iscam...
extract_group_matricesExtract the given data frame into a list of matrices by iscam...
fetch_file_namesRead the iscam starter file to get the iscam input file names
find_f_b40Find the Reference Removal Rate (RRR) 'bo_refpt' F_b0 which...
fix_mChange the column name 'm1' to 'm' unless both 'm1' and 'm2'...
gear_lu_tableCreate a gear lookup table showing which gear numbers are...
get_estimated_paramsFetch a data frame of the estimated MCMC parameters only
get_fancy_exprGet a properly-typeset version of the parameter name
get_fancy_namesGet a version of iSCAM parameter names in latex math format...
get_group_parvalsGet a set of parameter values from the models within the...
get_num_params_estExtract the number of parameters estimated in a model
get_parvalsGet a vector of values (median, CI interval, and end year)...
get_proj_biomass_rawExtract the projection biomass or depletion columns of raw...
gfiscam_themeggplot theme for gfiscam
gfiscamutilsgfiscamutils package
iscam.exe.fileiscam executable filename
iscam_paletteThe iSCAM model palette to use for plots by default
iscam.starter.fileiscam input data filename
is_iscam_modelDetermine if a model is a valid iSCAM model
is_iscam_model_groupDetermine if a list is a valid iSCAM model group
is_iscam_model_listDetermine if a list of models is a valid iSCAM model list
likelihood_tableCreate a table of likelihood outputs
linux.append.to.logThe Linux (bash) append to log operator string
linux.pipe.to.logThe Linux (bash) pipe to log operator string
load_iscam_filesConstruct an iscam model object from its input and output...
load_longerLoad CSV files in the 'longer' data format. These files will...
load_rds_fileLoad RDS file which was generated by 'create_rds_file()'
load_selestLoad the specially-formatted selectivity estimates file....
log.fileThe name of the log file used when running scripts
make.likelihood.tableMake an xtable of likelihood values - Herring specific
mcmc.age.fits.fileiscam MCMC output age fits filename
mcmc.age.resids.fileiscam MCMC output age residuals filename
mcmc.biomass.fileiscam MCMC output biomass filename
mcmc.catch.fileThe name of the ISCAM catch file (csv)
mcmc.fileiscam MCMC output filename
mcmc.fishing.mort.fileiscam MCMC output instantaneous fishing mortality filename
mcmc.fishing.mort.u.fileiscam MCMC output annual fishing mortality filename
mcmc.index.fits.fileiscam MCMC output index fits filename
mcmc.index.resids.fileiscam MCMC output index residuals filename
mcmc.index.standardized.resids.fileThe name of the ISCAM residuals file (csv)
mcmc.natural.mort.fileiscam MCMC output natural mortality filename
mcmc.proj.fileiscam MCMC projection filename
mcmc.recr.devs.fileiscam MCMC output recruitment deviations filename
mcmc.recr.fileiscam MCMC output recruitment filename
mcmc.sel.female.fileThe name of the ISCAM female selectivity file (csv)
mcmc.sel.fileiscam MCMC output selectivity fits filename
mcmc.sel.male.fileThe name of the ISCAM male selectivity file (csv)
mcmc.sr.fileThe name of the ISCAM stock recruitment file (csv)
mcmc_thinApply burnin and thinning to an MCMC posteriors data frame
mcmc.vuln.biomass.fileiscam MCMC output vulnerable biomass filename
mdl_clsThe iSCAM model class
mdl_grp_clsThe iSCAM model group class
mdl_lst_clsThe iSCAM model list class
model.classThe name of the ISCAM model class
model.lst.classThe name of the ISCAM model class
model_setupLoad models and set up lists and classes for the base model,...
modify_model_pathRead in model RDS files, modify the path attribute, and save
move_legend_to_empty_facetMoves a ggplot legend to an empty facet if one exists
mpd.proj.fileiscam MPD projection filename
output.filesA vector of ADMB output files for ISCAM
par.fileiscam parameter estimate filename
plot_age_fits_mcmcPlot MCMC age fits for an iSCAM model
plot_age_fits_mpdPlot MPD age fits for an iSCAM model
plot_age_resids_boxes_mcmcPlot MCMC age residuals for an iSCAM model
plot_age_resids_mcmcPlot MCMC age residuals bubbles for an iSCAM model
plot_age_resids_mpdPlot the age fits for an MPD model
plot_autocorr_mcmcPlot MCMC autocorrelations for iSCAM models
plot_biomass_grid_mcmcPlot a grid of MCMC biomass plots for iSCAM models
plot_biomass_mcmcPlot MCMC biomass for iSCAM models
plot_biomass_mpdPlot the MCMC time series trajectories for iscam models,...
plot_biomass_proj_mcmcPlot a model's time series (either spawning biomass or...
plot_catch_fit_mcmcPlot catch fit against catch data
plot_catch_fleetPlot catch by fleet
plot_distributionPlot a distribution function. Mostly for use with making...
plot_f_mcmcPlot MCMC fishing mortalities for iSCAM models
plot_index_mcmcPlot MCMC index fits or residuals for iSCAM models
plot_index_mpdPlot MPD index fits or residuals for iSCAM models
plot_pairs_mcmcPlot MCMC pairs for iSCAM models
plot_param_stats_mcmcPlot Autocorrelation, Effective sample size, Geweke...
plot_priors_posts_mcmcPlot MCMC priors and posteriors for iSCAM models
plot_q_mcmcPlot MCMC catchabilities for iSCAM models
plot_rdevs_mcmcPlot MCMC recruitment deviations for iSCAM models
plot_recr_grid_mcmcPlot a grid of MCMC recruitment plots for iSCAM models
plot_recr_mcmcPlot MCMC recruitments for iSCAM models
plot_recr_mpdPlot MPD recruitments for iSCAM models
plot_ref_pointsPlot reference point boxplots
plot_ref_points_dist_mcmcPlot DFO-style reference point figure with horizontal...
plot_selex_gear_mcmcPlot MCMC selectivities by single gear for iSCAM models
plot_selex_mcmcPlot MCMC selectivities for iSCAM models
plot_selex_mpdPlot MPD selectivities for iSCAM models
plot_sr_mcmcPlot the stock-recruitment relationship for an MCMC ISCAM...
plot_traces_mcmcPlot MCMC traces for iSCAM models
plot_ts_mcmcPlot MCMC time series plots for iSCAM models
plot_tv_selex_mpdPlor MCMC selectivities for iSCAM models
plot_vuln_mcmcPlot MCMC vulnerable biomass for iSCAM models
rdata.fileName of the model rdata file
read_control_fileRead in the iscam control file
read_data_fileRead in the iscam data file
read.listRead the data from the file into a list and return the list
read_mcmcRead in the MCMC results from an iscam model, reformat them,...
read_par_fileRead in the contents of the iscam par file
read_projection_fileRead in the contents of the iscam projection file
read_psvRead ADMB-generated psv file
read_report_fileRead in the iscam report (.rep) file
rename_gear_iscamRead in an ISCAM data file, replace all instances of the old...
rep.fileiscam report filename
replace_gear_name_and_saveReplace gear names in objects in an iSCAM output list, from...
replace_gear_namesChange the gear names in already-loaded models
retro.dirName of the retrospectives directory
run_iscamRun an iscam model through the 'base::shell()' command
run_multiple_iscamRun multiple iscam models in parallel
run_retroRun retrospectives for the given iscam model directory
sel_param_est_mpd_tableMake a table of selectivity parameter estimate comparisons...
set_dirsSet and return all model directories for the project
set_gear_languageTranslate the gear names and abbreviations in the models list...
simplify_namesSimplify MCMC parameter names for this package code
standardize_compsUpdate an iSCAM 'dat' file by standardizing all the age comps
strip_static_paramsStrip static parameters from MCMC output data
table_bio_deplCreate a table containing biomass and depletion estimates
table_catchCreate a table of catch, by Landings and Discards
table_catch_areaReturn a table by area, where the areas are defined by the...
table_catch_fleetReturn a table by fleet, where the fleets are determined by...
table_catch_fleetsReturn a table by fleet, where the fleets are determined by...
table_decisionCreate a decision table with a single reference point or...
table_decisionsCreate a wide decision table for iSCAM models, with all...
table_growth_paramsCreate table of the growth parameters which were input into...
table_index_valuesCreate a table of index data values
table_iscam_param_descCreate the ISCAM model parameter description table as found...
table_param_est_mcmcCreate a table of parameter estimates for iSCAM models
table_param_est_mpdCreate a table of MPD parameter comparisons
table_param_phi_mpdCreate a table comparing phi parameter
table_param_settingsCreate a table summarizing parameterization of an iSCAM model
table_ref_points_mcmcMake a table of reference points for MCMC iSCAM models
table_ref_rateMake a table containing the reference rate and values...
table_sens_param_changesCreate a table summarizing changes for sensitivity models
table_sens_qCreate a table comparing estimates of q across models
table_ts_values_mcmcCreate a table of time series estimates for MCMC iSCAM models
texCreate an expression from a string that may have a latex...
trTranslate from English to French
vec2dfCreate a one-row tibble from a vector of values
write_projection_fileWrite an ISCAM projection file (pfc file)
pbs-assess/gfiscamutils documentation built on Oct. 24, 2024, 1:37 p.m.