Package: MSEtool 4.0.0

Adrian Hordyk

MSEtool: Management Strategy Evaluation Toolkit

Development, simulation testing, and implementation of management procedures for fisheries (see Carruthers & Hordyk (2018) <doi:10.1111/2041-210X.13081>).

Authors:Adrian Hordyk [aut, cre], Quang Huynh [aut], Tom Carruthers [aut], Chris Grandin [ctb]

MSEtool_4.0.0.tar.gz
MSEtool_4.0.0.zip(r-4.7)MSEtool_4.0.0.zip(r-4.6)MSEtool_4.0.0.zip(r-4.5)
MSEtool_4.0.0.tgz(r-4.6-x86_64)MSEtool_4.0.0.tgz(r-4.6-arm64)MSEtool_4.0.0.tgz(r-4.5-x86_64)MSEtool_4.0.0.tgz(r-4.5-arm64)
MSEtool_4.0.0.tar.gz(r-4.7-arm64)MSEtool_4.0.0.tar.gz(r-4.7-x86_64)MSEtool_4.0.0.tar.gz(r-4.6-arm64)MSEtool_4.0.0.tar.gz(r-4.6-x86_64)
MSEtool_4.0.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
card.svg |card.png
MSEtool/json (API)
NEWS

# Install 'MSEtool' in R:
install.packages('MSEtool', repos = c('https://blue-matter.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/blue-matter/msetool/issues

Pkgdown/docs site:https://msetool.openmse.com

Uses libs:
  • c++– GNU Standard C++ Library v3
  • openmp– GCC OpenMP (GOMP) support library
Datasets:

On CRAN:

Conda:

cppopenmp

8.08 score 10 stars 3 packages 185 scripts 386 downloads 734 exports 37 dependencies

Last updated from:744dccfea3. Checks:11 ERROR, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64ERROR339
linux-devel-x86_64ERROR355
source / vignettesOK346
linux-release-arm64ERROR315
linux-release-x86_64ERROR337
macos-release-arm64ERROR244
macos-release-x86_64ERROR528
macos-oldrel-arm64ERROR231
macos-oldrel-x86_64ERROR404
windows-develERROR401
windows-releaseERROR263
windows-oldrelERROR372
wasm-releaseOK178

Exports:AAVEAAVYACAC<-AddDimensionAddFleetaddMMPsaddMPsAdviceAdviceDataAgencyAgency<-AgesAges<-ALKALK<-AllocationAllocation<-allometricalphaconvAnglerPerTripAnglerPerTrip<-ApplyACapplyMPApplyObsACArrangementArrangement<-Array2DFArray2ListArrayDivideArrayExtendArrayFill<-ArrayMultiplyArraySubtractArraySumASAP2DataASAP2OMAssess2MOMAssess2OMAuthorAuthor<-availAverageCatchAwatea2OMAWKAWK<-B0BAM2MOMBetaBeta<-betaconvBevertonHoltBevertonHolt_RelRecBiasBias<-BioeconomicBioeconomic<-BiomassBMSYBrodyCalcAgeClassesCalcAgeSizeKeyCalcAsymDistCalcAsymptoticDistCalcEquilibriumCalcInnovationCovcalcMeanCalcMSYCalcPerRecruitcalcProbCalcResidualStatsCalcSeasonsCalcSPR0CalcSurvivalCalcTSUnitsCalcUnfished_DynamicCalcUnfished_EquilibriumCalcUnfishedDistCalcUnfishedNumberCalcUnfishedSurvivalCalcYearsCALsimpCanCantCatchabilityCatchability<-CatchDataCatchFracCatchFrac<-CatchObsCheckCatchcheckMSECheckOMCheckPackageCheckParallelChkYrsChooseEffortChooseMChooseSelectClassesClasses<-ClosureClosure<-CombineFleetsCombineOMsCommonNameCommonName<-CompareBAMCompareSSCompareSS_BiomassCompareSS_NumberCompDataComplexesComplexes<-ComplianceCompliance<-CompObsControlControl<-ConvergeConvertConvertDataConvertFleetConvertImpConvertMOMConvertObsConvertOMConvertStockCos_thresh_tabCOSEWIC_BlowCOSEWIC_DplotCOSEWIC_HplotCOSEWIC_PplotCOSEWIC_reportCOSEWIC_tabCOSEWIC_tab_formattedCostCost<-CplotCPUECPUE<-CR2hCSRAcurErefCurrentCatchCurrentEffortCurrentLandingsCurrentYearCurrentYear<-cvCVCV<-CVatAgeCVatAge<-CVDistCVDist<-CVStayCVStay<-DataData_xlData2csvDataDirDataInitDataLagDataLag<-DataTrimDefaultAgesDefaultYearsDeleteLogsDepletionDepletion<-DepreciationDepreciation<-derive_beta_parDF2ArrayDFO_barDFO_histDFO_plotDFO_plot2DFO_projDFO_quantDFO_reportDFO_spiderDFO_tabDFO_tab_formatteddimDisableParallelDiscardMortalityDiscardMortality<-DiscardsDiscards<-DiscardsAtAgeDiscardsAtAge<-DiscardsAtSizeDiscardsAtSize<-DiscountDiscount<-DisinvestmentDisinvestment<-DistDist<-DistributionDistribution<-DLMDataDirDLMdiagdnormaldoHCRdoIfreqDomdoRecdouble_normalDoubleNormalDoubleNormalRetentionDoubleNormalRetentionWeightDoubleNormalWeightDropDimensionDynamicEFactorEFactor<-EfficiencyEfficiency<-EffortEffort<-EffortDataEffortObsEmailEmail<-EmpEmptyObjectEquilibriumErrorError<-ExampleMPsExploitationExploitation<-ExploitationDataExploitationObsExtendExtendAgesExtendAreasExtendClassesExtendSimsExtendYearsFDeadFeaseFecundityFecundity<-FecundityAtAgeFecundityAtLengthFecundityAtWeightFecundityModelsFecundityModelsAgeFecundityModelsLengthFecundityModelsWeightfetch.file.namesFinalFinal<-FInteractFitMovementFitStockTargetingFixFleetNamesFleetFleet<-FleetNamesFMSYFMSYrefFMSYref50FMSYref75FracOtherFracOther<-FRetainGenerateStockTargetingGenHistEffortGenMeanAtAgeGenMeanAtLengthGenMeanAtWeightGenMultiStockRecDevsGenRecDevsGenResidualsGetBAMFleetNamesGetBAMOutputGetMetaDatagetmov2getnIVsgetselGetSSRefPointsGompertzh2CRhconvHermHerm<-Histhist2HockeyStickHockeyStick_RelRecilogitImpImportBAMImportBAMDataImportSSImportSSDataImportSSReportImpSlotinch2mmIndicesObsInitialInitial<-InputInteractionsIntervalInterval<-InvestmentInvestment<-iSCAM2DataiSCAM2OMiSCAMcompsiSCAMindsisNewObjectisRelisRel<-join_plotsjoinDatajoinHistjoinMSEJoinYearkg2_1000lbkg2lbkg2mtKplotLag_DataLandingsLandings<-LandingsAtAgeLandingsAtAge<-LandingsAtSizeLandingsAtSize<-LastHistYearIndLastTACLatitudeLatitude<-lb2kglb2mtLengthLength<-LengthModelsLH2OMLifeHistoryLifeHistory<-LifeHistoryDataLifeHistoryObsList2ArrayListBAMStocksload.iscam.filesLoadArgsLoglogistic_50_95logitLongitudeLongitude<-LorenzenMortalityLengthLorenzenMortalityWeightLTYmakeMOMmakemovmakemov2makeRelmakeTransparentMaturityMaturity<-MaturityAtAgeMaturityAtLengthMaturityAtWeightMaturityModelsMaturityModelsAgeMaturityModelsLengthMaturityModelsWeightMaxAgeMaxAge<-maxFmaxF<-MaximumMaximum<-mconvMeanMean<-MeanAtAgeMeanAtAge<-MeanAtLengthMeanAtLength<-MeanAtWeightMeanAtWeight<-MinAgeMinAge<-MiscMisc<-ML2Dmm2inchModeMode<-ModelModel<-MOM_agg_fleetsMortalityAtAgeMovementMovement<-movestockCPPmovfit_RcppMPtypeMPurlMSE2SlickMSEextraMSYDiscardsMSYLandingsMSYRefsmultiDataSmultidebugmultiMSEN0nAgeNameName<-NAor0nAreaNaturalMortalityNaturalMortality<-NaturalMortalityModelsnComplexNeedednFleetNFrefNOAA_plotNOAA_plot2nRepsnReps<-nSimnSim<-nStockNumbernYearnYear<-ObsObs<-OMOMdocOMexampleOMinitOneRepoptCPUoptMSY_eqP10P100P50ParsPars<-PeriodPeriod<-PGKplotplot_movplot_SS2MOMplot_SS2OMplotFunplotmultiplotOFLplotquantplotRelPlusGroupPlusGroup<-PMLimitPMObjPNOFPopulatePopulateCatchabilityPopulateCatchObsPopulateClosurePopulateCompObsPopulateDepletionPopulateDiscardMortalityPopulateEffortPopulateEffortObsPopulateFecundityPopulateFleetPopulateIndexObsPopulateLengthPopulateMaturityPopulateNaturalMortalityPopulateObsPopulateObsACPopulateObsBiasPopulateObsCVPopulateObsErrorPopulateObsRefPopulateObsScalarPopulateObsShiftPopulateOMPopulateRetentionPopulateSelectivityPopulateSpatialPopulateSRRPopulateStockPopulateWeightPPDPplotPplot2predictLHProbStayingProbStaying<-ProjectProjectionYearProjectMOMpStarpStar<-PWhiskerpYearpYear<-qCVqCV<-qIncqInc<-quantile_plotR0R0<-R0convRandomrDirichletMultinomialread.control.fileread.data.fileread.mcmcread.par.fileread.projection.fileread.report.fileRealFeaseRecDevHistRecDevHist<-RecDevInitRecDevInit<-RecDevProjRecDevProj<-ReduceDimsReduceNSimRefRef<-RefCVRefCV<-ReferenceReference<-ReferenceDataRegionRegion<-RelationsRelations<-RelativeSizeRelativeSize<-RelRecFunRelRecFun<-RemovalsRenameReorderReplacereplic8ReportRequiredRetentionRetention<-RetentionAtAgeRetentionAtLengthRetentionAtWeightRetentionKnifeEdgeAgeRetentionKnifeEdgeLengthRetentionModelsRetentionModelsAgeRetentionModelsLengthRetentionModelsWeightRevenueRevenue<-RickerRicker_RelRecrunCOSEWICrunInMPrunMPrunMSES4SlotSizessample_steepness2SampleCparsSampleFleetParsSampleImpParsSampleObsParsSampleStockParsSaveSB0SBiomassSBMSYSchnuteSDSD<-sdconvSeasonsSeasons<-SeedSeed<-select_MPSelectivitySelectivity<-SelectivityAtAgeSelectivityAtLengthSelectivityAtWeightSelectivityKnifeEdgeAgeSelectivityKnifeEdgeLengthSelectivityModelsSelectivityModelsAgeSelectivityModelsLengthSelectivityModelsWeightSemelparousSemelparous<-SensesetupSetupParallelShareParSharePar<-showsimmovsimmov2SimulateSimulateMOMSizeSize<-SketchFunsmoothySourceSource<-SP0SpatialSpatial<-SpawnTimeFracSpawnTimeFrac<-SpeciesSpecies<-SPFromSPFrom<-SplotSPMSYSponsorSponsor<-SPRMSYSProductionSRalphaconvSRbetaconvSRRSRR<-SRRModelsSS2DataSS2DataMOMSS2MOMSS2OMSSBrefplotSSMOM2OMStockStock<-StockNamesStockTargetingSTYSubSubCparsSubOMSubsetsummarySumOverAgeSumOverAreaSumOverClassSumOverFleetSumOverStockSumOverYearSurveySurvey<-TACTACfilterTACsTargetingTargeting<-tdlnormThetaTheta<-Thresh_tabTimingtinyErrTplotTplot2Tplot3TradePlotTripsScalarTripsScalar<-trlnormTruncSDTruncSD<-tune_MPTuringTuringMOMUnfishedUnfishedDistUnfishedDist<-UnitsUnits<-updateMSEUpdateObjectUpdateSlotsUsesvalidcparsValidUnitsValueValue<-VOIVOI2VOIplotvonBertVPA2OMWeightWeight<-WeightatAgeWeightatLengthWeightatMeanLengthWeightFleetWeightFleet<-WeightModelsWHAM2OMwormplotWrappedNormalXL2DataXL2FleetXL2OMXL2StockYearLHYearLH<-YearsYield

Dependencies:abindclicpp11digestdplyrfarvergenericsggplot2gluegtableisobandlabelinglifecyclelubridatemagrittrpillarpkgconfigpurrrR6RColorBrewerRcppRcppArmadillorlangS7scalessnowsnowfallstringistringrtibbletidyrtidyselecttimechangeutf8vctrsviridisLitewithr

Readme and manuals

Help Manual

Help pageTopics
Access and Assign Slots from Compatible S4 ObjectsAC AC<- Access Beta Beta<- Bias Bias<- Classes Classes<- Compliance Compliance<- CPUE CPUE<- CV CV<- CVatAge CVatAge<- DiscardsAtAge DiscardsAtAge<- DiscardsAtSize DiscardsAtSize<- Dist Dist<- Error Error<- Exploitation Exploitation<- LandingsAtAge LandingsAtAge<- LandingsAtSize LandingsAtSize<- LifeHistory LifeHistory<- Mean Mean<- MeanAtAge MeanAtAge<- MeanAtLength MeanAtLength<- MeanAtWeight MeanAtWeight<- Misc Misc<- Model Model<- nAge Name Name<- nArea nComplex nFleet nSim nSim<- nStock Pars Pars<- Period Period<- Random Ref Ref<- RefCV RefCV<- Reference Reference<- SD SD<- Size Size<- Survey Survey<- Timing TruncSD TruncSD<- Units Units<- Value Value<- YearLH YearLH<-
Add Auto-Correlation to a Vector of ValuesAddAutoCorrelation
Add a Fleet to an Operating ModelAddFleet
Utility functions for multiMSE objectsaddMMPs
Management Advice Constructor and AccessorsAdvice
The 'advice' S4 Classadvice-class
The 'advicedata' S4 ClassAdviceData advicedata advicedata-class
Ages Constructor and AccessorsAges Ages<- MaxAge MaxAge<- MinAge MinAge<- PlusGroup PlusGroup<-
The 'ages' S4 Classages-class
Age-Structured Observation ModelAgeStructuredObs
Stock class objectsAlbacore Bluefin_tuna Bluefin_tuna_WAtl Blue_shark Butterfish Herring Mackerel Porgy Rockfish Snapper Sole Stock-class-objects Toothfish
MOM class objectsAlbacore_TwoFleet MOM-class-objects
Albacore Example StockAlbacoreExStock
Apply AR(1) autocorrelation to residuals, skipping NAsApplyAC
Apply multi Management Procedures (class MMP) to a hierarchical list of Data class objectsapplyMMP
Apply Management Procedures to an object of class DataapplyMP
Convert Between Arrays and Data FramesArray2DF array_df_conversion DF2Array
Perform Operations on Two ArraysArrayDivide ArrayExtend ArrayFill<- ArrayMultiply ArrayOperations ArraySubtract ArraySum
Convert ASAP 3 assessments into an operating modelASAP2Data ASAP2OM
Reads bootstrap estimates from a stock assessment model into a multi-fleet operating model.Assess2MOM
Reads bootstrap estimates from a stock assessment model (including VPA) into an operating model. 'Assess2OM' is identical to 'VPA2OM'.Assess2OM VPA2OM
Asymptotic Selectivity Example FleetAsympExFleet
Data class objectsAtlantic_mackerel China_rockfish Cobia Data-class-objects Example_datafile Gulf_blue_tilefish ourReefFish Red_snapper Simulation_1
What objects of this class are availableavail
Reads MCMC estimates from Awatea (Paul Starr) processed r file structure into an operating modelAwatea2OM
Import a multi-stock, multi-fleet OM from a BAM objectBAM2MOM BAM2OM
Get and Fix BAM Fleet NamesBAMFleetNames FixFleetNames GetBAMFleetNames
Extract Biological Time SeriesBiomass bio_timeseries SBiomass SProduction
BioeconomicBioeconomic Bioeconomic<- Cost Cost<- Depreciation Depreciation<- Discount Discount<- Disinvestment Disinvestment<- Investment Investment<- Revenue Revenue<-
The 'bioeconomic' S4 Classbioeconomic-class
Boxplot of TAC recommendationsboxplot.Data
Butterfish Example StockButterfishExStock
Calculate Age ClassesCalcAgeClasses
Calculate an Age-Size KeyCalcAgeSizeKey
Calculate the Asymptotic Spatial Distribution of a Movement MatrixCalcAsymDist
Calculate Absolute Equilibrium QuantitiesCalcEquilibrium
Calculate Innovation Covariance Matrix for Multivariate AR(1)CalcInnovationCov
Calculate MSY Reference PointsCalcMSY
Calculate Per-Recruit QuantitiesCalcPerRecruit
Calculate Reference YieldcalcRefYield
Calculate residual statistics for log-space index residualsCalcResidualStats
Unfished Spawning Production Per RecruitCalcSPR0
Calculate Cumulative Survival-at-AgeCalcSurvival
Convert Between Season Count and Time Unit LabelsCalcSeasons CalcTSUnits
Calculate Dynamic Unfished Population DynamicsCalcUnfished_Dynamic
Calculate Equilibrium Unfished Population DynamicsCalcUnfished_Equilibrium
Calculate the Unfished Spatial DistributionCalcUnfishedDist
Calculate Equilibrium Unfished Number-at-AgeCalcUnfishedNumber
Calculate Unfished SurvivalCalcUnfishedSurvival
Simplifies the CAL slot of data objectCALsimp
Identify management procedures (MPs) based on data availabilityCan Cant DLMdiag Needed
Extract or Assign Catch Time Seriescatch_timeseries Discards Discards<- Interactions Landings Landings<- Removals
Catchability Constructor and AccessorsCatchability Catchability<- Efficiency Efficiency<- qCV qCV<- qInc qInc<- Theta Theta<-
The 'catchability' S4 Classcatchability-class
Catch-and-Survey Observation ModelCatchAndSurveyObs
CatchData ConstructorCatchData
The 'catchdata' S4 Classcatchdata-class
CatchObs Constructor and AccessorsCatchObs
The 'catchobs' S4 Classcatchobs-class
Check catch data availability and unitsCheckCatch
Check for duplicated MPs namesCheckDuplicate
Check that specified MPs are valid and will run on MSEtool::SimulatedDataCheckMPs
Utility functions for MSE objectsaddMPs checkMSE joinHist joinMSE updateMSE
Check OM object is completeCheckOM
Check that a required package is installedCheckPackage
Manually map parameters for the historical period of operating modelChoose ChooseEffort ChooseM ChooseSelect
Combine Multiple Fleets into a Single FleetCombineFleets
Create a blank MP recommendations object (class Rec) of the right dimensionsCombineMMP
Combine Multiple Operating Models into OneCombineOMs
Commercial-Fleet Observation ModelCommercialFleetObs
Compare BAM and OM OutputCompareBAM
Compare SS3 and OM fishery dynamicsCompareSS CompareSS_Biomass CompareSS_Number
CompData ConstructorCompData
The 'compdata' S4 Classcompdata-class
Stock Complex Example Operating ModelComplexOM
CompObs Constructor and AccessorsCompObs
The 'compobs' S4 ClassCompObs-class compobs-class
Default OM Control OptionsControlDefault
Check ConvergenceConverge
Convert legacy S4 objects to new S4 object classesConvert
Convert a Legacy Data Object to a New data ClassConvertData
Convert a Legacy Fleet Object to the Current 'fleet' ClassConvertFleet
Convert a Legacy Imp Object to a New imp ClassConvertImp
Convert Legacy MOM Object to New om ClassConvertMOM
Convert a Legacy Obs Object to the Current 'obs' ClassConvertObs
Convert Legacy OM Object to New om ClassConvertOM
Convert a Legacy Stock Object to the Current 'stock' ClassConvertStock
Current default thresholds for COSEWIC satisficingCos_thresh_tab
Internal function for checking that the 'OM@cpars' is formatted correctlycparscheck
Plot the median biomass and yield relative to last historical yearCplot
Convert Between Steepness and Compensation RatioCR2h h2CR
Constructor and Accessor for 'Data'Data
Read in Data object from Excel spreadsheetData_xl
The 'data' S4 Classdata-class
Class ''Data''Data-class Data-legacy-class
Converts a Data object into a .csv data fileData2csv
DataDescriptionDataDescription
Directory of the data in the installed package on your computerDataDir
Data Helper FunctionsDataHelpers LastHistYearInd LastTAC ProjectionYear
Initialize Data Input FilesDataInit
Data-Rich Observation ModelDataRichObs
DataSlotsDataSlots
Trim Data Object by Final YearDataTrim
Fleet class objectsDecE_Dom DecE_HDom DecE_NDom FlatE_Dom FlatE_HDom FlatE_NDom Fleet-class-objects Generic_DecE Generic_FlatE Generic_Fleet Generic_IncE IncE_HDom IncE_NDom Low_Effort_Non_Target Targeting_Small_Fish Target_All_Fish
Default Ages and YearsDefaultAges DefaultYears
Delete the Log DirectoryDeleteLogs
Depletion Constructor and AccessorsDepletion Depletion<- Final Final<- Initial Initial<-
The 'depletion' S4 Classdepletion-class
Department of Fisheries and Oceans stock status bar plotDFO_bar
Department of Fisheries and Oceans historical plotDFO_hist
Department of Fisheries and Oceans trade-off plotDFO_plot
Department of Fisheries and Oceans default plot 2DFO_plot2
Department of Fisheries and Oceans projection plotDFO_proj
Department of Fisheries and Oceans biomass quantile plotDFO_quant
Create a standard DFO MSE reportDFO_report
DFO performance spider plot (top three MPs)DFO_spider
Create a standard DFO performance tableDFO_tab
A formatted version of the standard DFO performance plot, color coded by thresholdsDFO_tab_formatted
Dimensions of an Objectdim
Add or Drop Named Dimensions of an ArrayAddDimension dimension-utils DropDimension
Discard MortalityDiscardMortality DiscardMortality<-
The 'discardmortality' S4 Classdiscardmortality-class
Directory of the installed package on your computerDLMDataDir
Hockey Stick Harvest control rule that modifies TAC.doHCR
Create indices that are sampled at various frequenciesdoIfreq
Determine dominate MPsDom
Dome-Shaped Selectivity Example FleetDomeExFleet
Calculate a management recommendation given constraintsdoRec
Effort Constructor and AccessorsAnglerPerTrip AnglerPerTrip<- Distribution Distribution<- Effort Effort<- Maximum Maximum<- Mode Mode<- Targeting Targeting<- TripsScalar TripsScalar<-
The 'effort' S4 Classeffort-class
EffortData Constructor and AccessorsEffortData
The 'effortdata' S4 Classeffortdata-class
EffortObs Constructor and AccessorsEffortObs
The 'effortobs' S4 Classeffortobs-class
A flexible empirical management procedure.Emp
Test Whether an Object is EmptyEmptyObject
The 'equilibrium' S4 Classequilibrium-class
Example Management ProceduresAverageCatch CurrentCatch CurrentEffort CurrentLandings ExampleMPs
'exploitationdata' ClassExploitationData exploitationdata-class
ExploitationObs ConstructorExploitationObs
The 'exploitationobs' S4 Classexploitationobs-class
Extend an Array Along Named DimensionsExtend ExtendAges ExtendAreas ExtendClasses ExtendSims ExtendYears
Unfished Reference Point QuantitiesB0 extract-unfished N0 SB0 SP0
MP feasibility diagnosticFease
Fecundity Constructor and AccessorsFecundity Fecundity<-
The 'fecundity' S4 Classfecundity-class
Fecundity ModelsFecundity-Models FecundityAtAge FecundityAtLength FecundityAtWeight FecundityModels FecundityModelsAge FecundityModelsLength FecundityModelsWeight
Extract Fishing Mortality Time SeriesFDead FInteract FRetain F_timeseries
Fit a Movement Matrix to Target Spatial ParametersFitMovement
Fit statistical properties of historical stock targetingFitStockTargeting
FleetClosure Closure<- Fleet Fleet<- WeightFleet WeightFleet<-
The 'fleet' S4 Classfleet-class
Class ''Fleet''Fleet-class Fleet-legacy-class
FleetDescriptionFleetDescription
Reference management procedurescurEref FMSYref FMSYref50 FMSYref75 NFref
Generate Stochastic Stock Targeting TrajectoriesGenerateStockTargeting
Obs class objectsGeneric_Obs Imprecise_Biased Imprecise_Unbiased Obs-class-objects Perfect_Info Precise_Biased Precise_Unbiased
Generate Stochastic Historical Effort Time SeriesGenHistEffort
Generate Mean-at-Age, Length, or Weight ArraysGenMeanAtAge GenMeanAtLength GenMeanAtWeight
Generate Correlated Multi-Stock Recruitment DeviationsGenMultiStockRecDevs
Generate Stock-Recruitment DeviationsGenRecDevs
Generate (log-space) residuals with truncated log-normal distributionGenResiduals
get object classgetclass
Get part of an MP specific data-listgetDataList
Extract the first dimension of a hierarchical list of recommendation objectsgetfirstlev
Retrieve Operating Model MetadataGetMetaData
Optimization function to find a movement model that matches user specified movement characteristics modified for Rcpp.getmov2
Search R session for MPgetMP
Count independent variables for a MICE relationship at position x in a Rel listgetnIVs
Calculate selectivity curvegetsel
Get Reference Points from Stock Synthesis OutputGetSSRefPoints
Stock recruit parameterizationhconv R0conv SRalphaconv SRbetaconv
Internal Herm functionscheckHerm expandHerm Herm-int subsetHerm
'hist' Class and AccessorHist
'hist' Classhist-class
Class ''Hist''Hist-class Hist-legacy-class
Wrapper for histogram functionhist2
HistDescriptionHistDescription
Imp Constructor and AccessorImp
Implementation Errorimp-class
Class ''Imp''Imp-class Imp-legacy-class
ImpDescriptionImpDescription
Import BAM Output into an Operating ModelGetBAMOutput ImportBAM ListBAMStocks
Import BAM Assessment Data into an Operating ModelImportBAMData
Import a Stock Synthesis Model into an Operating ModelImportSS
Import SS3 data into a Data objectImportSSData
Import SS3 Report directories with optional parallel processingImportSSReport
ImpSlot Constructor and AccessorsImpSlot
The 'indicesdata' S4 Classindicesdata-class
IndicesObs Constructor and AccessorsIndicesObs
The 'indicesobs' S4 Classindicesobs-class
~~ Methods for Function 'initialize' ~~initialize-methods
Function to run a set of input control methodsInput
Reads iSCAM files into a hierarchical R list objectfetch.file.names iSCAM load.iscam.files read.control.file read.data.file read.mcmc read.par.file read.projection.file read.report.file
Reads MPD or MCMC estimates and data from iSCAM file structure into an operating modeliSCAM2Data iSCAM2OM
Combines all iSCAM age composition data across fleetsiSCAMcomps
Combines indices into a single index using linear modelling (** Deprecated **)iSCAMinds
Test Whether an Object is a Default-Constructed InstanceisNewObject
Plot several plots with a shared legendjoin_plots
Join Data objects present in a listjoinData
Join Two Objects Along the Year DimensionJoinYear
KOBE plot: a projection by projection plot of F/FMSY and B/BMSYKplot
Lag the time-series slots in a 'Data' object by a specified number of time-stepsLag_Data
Dimensions of a hierarchical list objectldim
Length Constructor and AccessorsALK ALK<- Length Length<-
Length-at-Age Growth ModelsBrody Gompertz Length-at-Age-Models LengthModels Schnute vonBert
The 'length' S4 Classlength-class
Length-Structured Observation ModelLengthStructuredObs
Predict missing life-history parametersLH2OM predictLH
LHdatabaseLHdatabase
'lifehistorydata' ClassLifeHistoryData lifehistorydata-class
LifeHistoryObs ConstructorLifeHistoryObs
The 'lifehistoryobs' S4 Classlifehistoryobs-class
Convert Between Lists and ArraysArray2List list-array-conversion List2Array
Load Function Arguments into an EnvironmentLoadArgs
Display Log WarningsLog
Logit and Inverse Logit (Sigmoid) Functionsilogit logit
Utility for making multi-OMsmakeMOM
Calculates movement matrices from user inputs for fraction in each area (fracs) and probability of staying in areas (prob)makemov
Calculates movement matrices from user inputs for fraction in each area (fracs) the relative fraction moving to other areas, plus a mean probability of staying in any given area.makemov2
MICE relationships for multi-OMmakeRel predict.Rel print.Rel simulate.Rel
Make colors transparentmakeTransparent
Maturity Constructor and AccessorsMaturity Maturity<- Semelparous Semelparous<-
The 'maturity' S4 Classmaturity-class
Maturity Models: Age, Length, and WeightMaturity-Models MaturityAtAge MaturityAtLength MaturityAtWeight MaturityModels MaturityModelsAge MaturityModelsLength MaturityModelsWeight
Depletion and F estimation from mean length of catchesML2D
Class ''MMSE''MMSE-class MMSE-legacy-class
Selectivity, Retention, Weight, Fecundity, and Maturity Model Helpersallometric dnormal double_normal logistic_50_95 model-helpers
Class ''MOM''MOM-class MOM-legacy-class
Apply the movement model to the stock for one time-stepmovestockCPP
Rcpp version of the Optimization function that returns the squared difference between user specified and calculated movement parameters.movfit_Rcpp
Fill any NAs arising from MPCalcs (hermaphroditism mode)MPCalcsNAs
Management Procedure TypeMPtype
'mse' Classmse-class
Class ''MSE''MSE-class MSE-legacy-class
Convert an 'mse' Object to a Slick ObjectMSE2Slick
MSEDescriptionMSEDescription
Load more data from MSEextra packageMSEextra
Access MSY Reference Point SlotsBMSY FMSY MSY-accessors MSYDiscards MSYLandings MSYRefs SBMSY SPMSY SPRMSY
Internal function to calculate MSY Reference PointsMSYCalcs
Combine data among fleetsmultiData
Combine data among stocksmultiDataS
A basic comparison of runMSE output (MSE) and multiMSE (MMSE)multidebug
Multi-Stock Multi-Fleet Example Operating ModelMultiStockOM
Access Stock or Fleet NamesFleetNames name-accessors StockNames
NaturalMortality Constructor and AccessorsNaturalMortality NaturalMortality<-
The 'naturalmortality' S4 Classnaturalmortality-class
Natural Mortality ModelsLorenzenMortalityLength LorenzenMortalityWeight MortalityAtAge NaturalMortality-Models NaturalMortalityModels
Item in list: get the list values from a list of listsNIL
National Oceanographic and Atmospheric Administration default plot 1NOAA_plot
Extract Number-at-Age time seriesNumber
Obs Constructor and AccessorObs Obs<-
The 'obs' S4 Classobs-class
Class ''Obs''Obs-class Obs-legacy-class
ObsDescriptionObsDescription
OM Constructor and AccessorOM
Access and Modify OM SlotsAgency Agency<- Allocation Allocation<- Author Author<- CatchFrac CatchFrac<- Complexes Complexes<- Control Control<- CurrentYear CurrentYear<- DataLag DataLag<- EFactor EFactor<- Email Email<- Herm Herm<- Interval Interval<- Latitude Latitude<- Longitude Longitude<- maxF maxF<- nReps nReps<- nYear nYear<- OM-accessors pStar pStar<- pYear pYear<- Region Region<- Relations Relations<- Seasons Seasons<- Seed Seed<- SharePar SharePar<- Source Source<- Sponsor Sponsor<-
The 'om' S4 Classom-class
Class ''OM''OM-class OM-legacy-class
OMDescriptionOMDescription
Generate OM Documentation ReportOMdoc
Copy example OM XL and OM DocumentationOMexample
Initialize Operating ModelOMinit
Determine optimal number of cpusoptCPU
Imp class objectsImp-class-objects Overages Perfect_Imp
Performance Metrics MethodsAAVE AAVY LTY P10 P100 P50 PerformanceMetric PGK PNOF STY Yield
The 'perrecruit' S4 Classperrecruit-class
Plot Data objectplot.Data
Standard plot for an object of class MMSE (multi MSE)plot.MMSE
Standard plot for an object of class MOMplot,MOM,missing-method plot.MOM
Plot MSE objectplot.MSE
Plot Operating Model Objectplot.Fleet plot.Hist plot.Imp plot.Obs plot.OM plot.pars plot.Stock
Print out plotting functionsplotFun
A basic SSB plot for debugging runMSE outputplotmulti
A generic OFL plot for NOAA useplotOFL
A fairly tidy time-series quantile plotplotquant
Plot a relationship between stocksplotRel
Create a table of Performance Limits and Performance ObjectivesPMLimit PMObj
An object for storing data for analysis using data-limited methodsPMobj-class
'popdynamics' Classpopdynamics popdynamics-class
Populate Operating Model ComponentsPopulate
Populate a Catchability ObjectPopulateCatchability
Populate Catch Observation ErrorPopulateCatchObs
Populate a Closure ObjectPopulateClosure
Populate Composition Observation ErrorPopulateCompObs
Populate a Depletion ObjectPopulateDepletion
Populate a DiscardMortality ObjectPopulateDiscardMortality
Populate an Effort ObjectPopulateEffort
Populate Effort Observation ErrorPopulateEffortObs
Populate a Fecundity ObjectPopulateFecundity
Populate a Fleet ObjectPopulateFleet
Populate Index Observation ErrorPopulateIndexObs
Populate a Length ObjectPopulateLength
Populate a Maturity ObjectPopulateMaturity
Populate a Natural Mortality ObjectPopulateNaturalMortality
Populate an Obs ObjectPopulateObs
Populate an Operating ModelPopulateOM
Populate a Retention ObjectPopulateRetention
Populate a Selectivity ObjectPopulateSelectivity
Populate a Spatial ObjectPopulateSpatial
Populate an SRR ObjectPopulateSRR
Populate a Stock ObjectPopulateStock
Populate a Weight-at-Age ObjectPopulateWeight
Specifying Biological and Fleet Schedulespars-model-meanatage populating-schedules schedule-population
Extract and Reconstruct Posterior Predicted Data (PPD)PPD
A projection by projection plot of F/FMSY and B/BMSYPplot
A projection by projection plot of F/FMSY, B/BMSY, B/B0, and yieldPplot2
Print method for 'multiHist' objectsprint.multiHist
Print a 'RepList' objectprint.RepList
Project an Operating Model Over the Projection PeriodProject
Performance Whisker PlotPWhisker
A quantile plotquantile_plot
Dirichlet-Multinomial SamplerrDirichletMultinomial
MP feasibility diagnostic using real dataRealFease
Class ''Rec''Rec-class
Reduce redundant Sim, Year, and Age dimensions in arraysReduceDims
Reduce the number of simulationsReduceNSim
Reference Points Objectreference-class
'referencedata' ClassReferenceData referencedata-class
The 'refpointsMSY' S4 ClassrefpointsMSY-class
Rename Stocks and Fleets in an OMRename
Reorder Stocks and Fleets in an OMReorder
Replace an existing Stock, Fleet, Obs, or Imp objectReplace
Enlarge (replicate) a DLM data object to create an additional dimension for simulation / sensitivity testingreplic8
Generate a Data ReportReport
ReqDataReqData
What management procedures need what dataRequired
RetentionRetention Retention<-
The 'retention' S4 Classretention-class
Retention ModelsDoubleNormalRetention DoubleNormalRetentionWeight Retention-Models RetentionAtAge RetentionAtLength RetentionAtWeight RetentionKnifeEdgeAge RetentionKnifeEdgeLength RetentionModels RetentionModelsAge RetentionModelsLength RetentionModelsWeight
COSEWIC MSE run using the correct MPs and projected time horizonCOSEWIC_Blow COSEWIC_Dplot COSEWIC_Hplot COSEWIC_Pplot COSEWIC_report COSEWIC_tab COSEWIC_tab_formatted runCOSEWIC
Runs input control MPs on a Data object.runInMP
Run a Management ProcedurerunMP
Run a Management Strategy EvaluationrunMSE
Summarise S4 Object Memory Usage by SlotS4SlotSizes
Save an Object to DiskSave
Select DataList for an MP from 'MMSE@PPD'select_MP
SelectivityisRel isRel<- Selectivity Selectivity<-
The 'selectivity' S4 Classselectivity-class
Selectivity ModelsDoubleNormal DoubleNormalWeight Selectivity-Models SelectivityAtAge SelectivityAtLength SelectivityAtWeight SelectivityKnifeEdgeAge SelectivityKnifeEdgeLength SelectivityModels SelectivityModelsAge SelectivityModelsLength SelectivityModelsWeight
Sensitivity analysisSense
Setup parallel processingsetup
Set Up Parallel Processing for openMSE WorkflowsCheckParallel DisableParallel SetupParallel
Show Methodsshow,advice-method show,ages-method show,catchability-method show,catchobs-method show,compobs-method show,data-method show,depletion-method show,discardmortality-method show,effort-method show,effortobs-method show,equilibrium-method show,exploitationobs-method show,fecundity-method show,fleet-method show,hist-method show,indicesobs-method show,length-method show,lifehistoryobs-method show,maturity-method show,mse-method show,naturalmortality-method show,obs-method show,om-method show,perrecruit-method show,popdynamics-method show,refpointsMSY-method show,retention-method show,selectivity-method show,spatial-method show,srr-method show,stock-method show,stocktargeting-method show,weight-method show-methods
Show MSEtool S4 objectsshow show,Data-method show,Hist-method show,MMSE-method show,MOM-method show,MSE-method show,OM-method show-MSEtool
Show the output of a PMshow,PMobj-method
Show the output of a single MP recommendationshow,Rec-method
Slot in list: get the slot values from a list of objectsSIL
Simulate Catch-at-Age DatasimCAA
Simulate Catch-at-Length DatasimCAL
Calculates movement matrices from user inputsplot_mov simmov
Calculates movement matrices from user specified distribution among other areassimmov2
Simulate Operating Model DynamicsSimulate
SimulatedData DataSimulatedData
Run a multi-fleet multi-stock Management Strategy EvaluationmultiMSE ProjectMOM SimulateMOM
Single Stock Example Operating ModelSingleStockOM
Manually map the historical relative fishing effort trajectory.SketchFun
General purpose polynomial smoothersmoothy
Spatial Constructor and AccessorsArrangement Arrangement<- CVDist CVDist<- CVStay CVStay<- FracOther FracOther<- Movement Movement<- ProbStaying ProbStaying<- RelativeSize RelativeSize<- Spatial Spatial<- UnfishedDist UnfishedDist<-
The 'spatial' S4 Classspatial-class
Standard MSE projection plotSplot
SRR Constructor and AccessorsR0 R0<- RecDevHist RecDevHist<- RecDevInit RecDevInit<- RecDevProj RecDevProj<- RelRecFun RelRecFun<- SpawnTimeFrac SpawnTimeFrac<- SPFrom SPFrom<- SRR SRR<-
The 'srr' S4 Classsrr-class
Stock–Recruitment Relationships (SRR)BevertonHolt BevertonHolt_RelRec HockeyStick HockeyStick_RelRec Ricker Ricker_RelRec SRRModels
Reads data Stock Synthesis file structure into a Data object using package r4ssSS2Data
Reads data Stock Synthesis file structure into a nested Data object analogous with multiMSESS2DataMOM
Import Stock Synthesis to MOM (2-sex multi-fleet) or OM (single-sex, single-fleet)MOM_agg_fleets plot_SS2MOM plot_SS2OM SS2MOM SS2OM SSMOM2OM
Plot Spawning stock biomass and reference points for both historical and projected periodSSBrefplot
Standardize fishing effort across stocks for each fleetStandardizeEffort
Stock Constructor and AccessorsCommonName CommonName<- Species Species<- Stock Stock<-
The 'stock' S4 Classstock-class
Class ''Stock''Stock-class Stock-legacy-class
StockDescriptionStockDescription
Stock Targeting ConstructorStockTargeting
The 'stocktargeting' S4 Classstocktargeting-class
Subset MSE object by management procedure (MP) or simulation.Sub
Subset the cpars slot in an operating modelSubCpars SubCpars,MOM-method SubCpars,OM-method
Subset a Stock, Fleet, Obs, or Imp object from an OM objectSubOM
Subset an object by simulation, year, age, MP, and/or fleetSubset
Summary of Data objectsummary,Data-method
Summary of MMSE objectsummary,MMSE-method
Summary of MSE objectsummary,MSE-method
Sum over named array dimensionsSumOverAge SumOverArea SumOverClass SumOverFleet SumOverStock SumOverYear
Calculate TAC recommendations for more than one MPTAC
TAC FilterTACfilter
Extract TAC Recommendations from an MSE ObjectTACs
Taxa_TableTaxa_Table
Tom's expand gridTEG
OM class objectsOM-class-objects testOM
Current default thresholds for DFO satisficingThresh_tab
'Timeseries' Classtimeseries-class
Remove observation, implementation, and process errortinyErr tinyErr,OM-method
Generic Trade-Plot FunctionNOAA_plot2 Tplot Tplot2 Tplot3 TradePlot
Tune MPtune_MP
Turing TestTuring TuringMOM
Two-Fleet Example Operating ModelTwoFleetOM
'unfished' ClassDynamic Equilibrium Unfished unfished unfished-class
Unit Conversion Functionsinch2mm kg2lb kg2mt kg2_1000lb lb2kg lb2mt mm2inch unit-conversions
Update an S4 Object and Its SlotsUpdateObject UpdateSlots
Find the Management Procedures that use a particular data slotUses
Valid custom parameters (cpars)validcpars
Return Valid UnitsValidUnits
Calculate Value Of InformationVOI
Calculate Value Of Information 2VOI2
Yet another Value of Information PlotVOIplot
Weight Constructor and AccessorsAWK AWK<- Weight Weight<-
The 'weight' S4 Classweight-class
Weight-at-Age and Weight-at-Length ModelsWeight-Models WeightatAge WeightatLength WeightatMeanLength WeightModels
Takes a fitted SAM model and samples historical population and fishing dynamics from the MLE fit and variance-covariance matrix.WHAM2OM
Biomass wormplotwormplot
Wrapped Normal DistributionWrappedNormal
Internal function to write CSVs for objectswriteCSV
Import a Data object from Excel fileXL2Data
Import Fleet Object from Excel fileXL2Fleet
Load OM from Excel fileXL2OM
Import Stock Object from Excel fileXL2Stock
Calculate or Extract Time Step ValuesCalcYears Years