Package: FIMS 0.9.3.9000

Overview | Who Should Use This Guide | Prerequisites | FIMS Code Structure | Directory Structure | Naming Conventions | C++ Naming Conventions | R Naming Conventions | Module-Specific Conventions | Step-by-Step Guide | Related documentation | Documentation expectations | Step 1: Create the C++ implementation | Class roles in the C++ layer | 1.1 Create or update the base class | 1.2 Create or update the implementation class | 1.3 Create or update the umbrella header | Step 2: Build the Rcpp interface | 2.1 Understand the parameter objects first | 2.2 Create or update the interface class | 2.3 Register parameters with TMB in add_to_fims_tmb_internal() | 2.4 Extract results in finalize() | Step 3: Register the module with the R API | 3.1 Update src/fims_modules.hpp | 3.2 Update R/FIMS-package.R | Step 4: Connect the module to the current R workflow | 4.1 Update the configuration and default-parameter path | 4.2 Update initialize_modules.R | 4.3 Keep the full run path in mind | Step 5: Add targeted tests | 5.1 C++ Google tests | 5.2 R testthat tests | Step 6: Finalize the documentation and build checks | 6.1 Module-specific documentation | Files to modify: complete checklist | Required or commonly required files | Validation checklist | Common patterns and best practices | Parameter handling | ID management and lifecycle | TMB integration | Namespace organization | Troubleshooting | Common issues | "undefined symbol" errors when loading the package | Parameters are not being estimated | Values are not appearing back in R after a run | The module initializes in R but is missing expected fields | Getting help | Examples and references | Code examples | Documentation resources | Summary

FIMS | Loading the package | Getting help | Memory | Data | data_big | FIMSFrame() | Configurations | create_default_configurations() | Update configurations | Parameters | create_default_parameters() | Update parameters | Fit | initialize_fims() | fit_fims() | Example | Logging system | Sensitivities | Initial values | Age only | Length

Projections in FIMS | Without projections | Projections | Data | Model | Model fit | Model summaries

Modules in R | Rcpp Interface | fims namespace | What is a namespace? | Maturity example | fims_popdy::LogisticMaturity class | Population class | Overview | Thinking in R

What is C++ | Definition | Why use C++ | Writing C++ | Basics | Types | Hello World example | add example | Vectors | Constants | Templates | Syntax in FIMS | Compiling directions | Classes | MyClass example | Instantiate and initialize | Inheritance | Polymorphism | Pointers and References | Pointers | References | Modifying Pointers | Memory Management | Shared pointers

What is Rcpp | Definition | Why use Rcpp | Writing C++ functions | Inline C++ code in R | Calling .cpp files from R | Benchmarking against R | C++ in FIMS | Rcpp Types | Rcpp scalar classes | Rcpp vector classes | SEXP in R | Type conversion | Rcpp methods | Rcpp modules | RCPP_MODULE | RCPP_EXPOSED_CLASS | Modules in FIMS

Other sources of information | Data format | data_big | FIMSFrame() | Landings (type == "landings") | Indices (type == "index") | Age compositions (type == "age_comp") | Length compositions (type == "length_comp") | Weight-at-age data (type == "weight_at_age") | Age-to-length conversion (type == "age_to_length_conversion")

Introduction | Methods | Time-series model | Catch-at-age model | Parameters | Code | Results

Overview | ☁️ Google Cloud Workstations | 🌐 GitHub Codespaces | 🐧 WSL2 | 🧑‍💻 Local | 🙋 Need Help?