Man pages for jkbest2/spatq
Use spatially varying catchability to standardize fishery-dependent data

all_res_file_pathsList paths for all result files
attach_optdiagsAttach optimization diagnostics
bias_metricEstimate bias of estimation models
build_expr_strBuild an expression string from a list of string vectors
create_index_dfCreate a data frame with index locations and times
dim_or_lenGet 'dim' if available, 'length' otherwise
domain_boundaryDefine the domain boundary
em_estdEstimated parameters for an estimation model
em_subsampleSpecify data subsample for estimation model
field_imagePlot a field
fit_spatqFit a spatq model by maximum likelihood
fix_nlminb_fitMake 'nlminb' output match 'optim' output
fixpar_corrCorrelation matrix of the fixed-effect parameters
fixpar_corrplotPlot the fixed-effect parameter correlation matrix
fixpar_covcondCalculate the condition number of the fixed-effect parameter...
fixpar_gradGradients at the fitted values
fixpar_highcorrFixed-effect parameters with high correlations
fixpar_mgcMaximum gradient component at fitted parameter values
fixpar_sdReturn the standard deviations of the fixed-effect parameters
gather_nvecGather a named vector into a list
generate_aniso_femGenerate anisotropic FEM matrices
generate_empty_projectionGenerate an empty project matrix
generate_femGenerate FEM matrices
generate_meshGenerate INLA mesh
generate_projectionGenerate a projection matrix
get_coordrefRead the index to coordinate reference table
get_index_filetypeGet index file type
get_newparsGet updated parameter values
index_pathConstruct the relative path to the index file output by a...
init_fixefInitial estimates of fixed effect parameters
interleave_estgenAlternate estimated and generative parameter vectors
is_estd_procCheck if process is estimated
isgenIs this parameter generative or estimated?
layout_matConstruct layout matrix for field plots
loc_gridGenerate a location grid
make_sim_adfunCreate ADFun from simulated data
map_correlationCalculate the correlation between true and estimated...
mgcMaximum gradient component
new_spatq_setupSet up inputs for spatq model
nulleigsFind the parameters that contribute to a singular covariance...
par_exprPretty expressions for plotting parameter names
par_expr_partsStrings from parameter names to be expression-ified
pars_dataParameter values from data elements
parse_coordsParse a tuple of numbers read as a string
pars_tauThe SPDE construction uses parameters kappa and tau, while...
plot_colorbarPlot a colorbar legend
plot_fieldPlot spatial and spatiotemporal fields
plot_popstatePlot array of population states (simulated "truth")
posdefhessIs the Hessian positive definite?
prepare_adfunMake a TMB ADFun
prepare_dataPrepare the 'data' argument for the 'spatq' model
prepare_mapPrepare a 'map'
prepare_parsPrepare parameter list
prepare_proc_switchPrepare process switch
prepare_randomPrepare 'random'
proc_colormapColormaps for numbers density and weight per group fields
project_fieldProject random effects, reshape to array
rdata_pathConstruct the relative path to the Rdata fit file
read_all_indicesLoad index CSVs for a study
read_catchRead simulated data
read_catchabilityRead catchability
read_estpopRead and reshape population estimates
read_indexRead an index from a fitted model
read_index_csvRead indices of abundance
read_popstateRead true population state for each year
read_rdataRead saved Rdata from a fitted model
re_par_idxGeneral random effects parameter index
repl_dirDirectory name for each replicate
rescale_indexRescale indices
res_file_pathsPaths to each results file
rmse_metricRoot mean square error
save_fitSave fit results
save_indexSave true and estimated indices to a CSV
sim_file_pathsPaths to simulated data sets
spat_par_idxSpatial parameter index
spatqSpatially varying catchability for fishery-dependent...
spatq_fitFit a spatq model by maximum likelihood
spatq_objContstruct a spatq objective function
spatq_optcontrolControl parameters for optimization
spatq_simsetupConstruct a spatq_setup from a simulated data set
spatq_simstudyspecSimulation study specification
specify_estimatedSpecify which parameters to estimate
study_dirDirectory where a study's simulations live
subsample_catchSubsample catch by year
terminate_optTest whether optimization should be stopped
true_percentilePercentile of true value in estimated distribution
update_oneparUpdate a single parameter vector
update_setupUpdate a model setup
verify_ident_fixefVerify that fixed effects are identifiable
verify_setequalVerify two sets are equal
verify_spatqCheck 'spatq' inputs
verify_spatq_dimsCheck 'spatq' component dimensions
verify_spatq_mapCheck that 'map' is self-consistent
verify_spatq_namesCheck all 'spatq' components are present
jkbest2/spatq documentation built on Sept. 22, 2022, 3:22 a.m.