fm_checkdesign: Check parameter structure of Hightower et al. (2001) models

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/fm_checkdesign.R


Check design of parameter structure before use in function fm_telemetry.


fm_checkdesign(occasions = NULL, design = NULL, type = "F" )



total number of occasions that will be modeled in data


vector of characters specifying the occasion parameter structure (see details).


character type of parameter to which design will be applied: F = fishing mortality, M = natural mortality, and P = probability of detection. Default = F.


The program allows the configuration of different parameter structure for the estimation of fishing and natural mortalities, and detection probabilities. These structures are specified in design. Consider the following examples:

Example 1

Tags are relocated over seven occasions. One model structure might be constant fishing mortality estimates over occasions 1-3 and 4-6. To specify this model structure: design is c(“1”,“4”).

Note: The structures of design must always contain the first occasion for fishing mortality and natural mortality, whereas the structure for the probability of detection must not contain the first occasion.

Example 2

Tags are relocated over six occasions. One model structure might be separate fishing mortality estimates for occasion 1-3 and the same parameter estimates for occasions 4-6. The design is c(“1:3*4:6”).

Note: The structures of Fdesign and Mdesign must always start with the first occasion, whereas the structure for Pdesign must always start with the second occasion.

Use the multiplication sign to specify occasions whose estimates of F, M or P will be taken from values of other occasions.

Example 3

Specification of model 3 listed in Table 1 of Hightower et al. (2001) is shown. Each occasion represented a quarter of the year. The quarter design for F specifies that quarterly estimates are the same in both years. design is c(“1*14”,“4*17”,“7*20”,“11*24”).

Example 4

In Hightower et al. (2001), the quarter and year design specifies that estimates are made for each quarter but are different for each year. design is

c(“1”, “4”, “7”, “11”, “14”, “17”, “20”, “24”).

If the number of occasions to be assigned parameters from other occasions are less than the number of original parameters (e.g., c(“11:13*24:25”), then only the beginning sequence of original parameters equal to the number of occasions are used. For instance, in c(“11:13*24:25”), only parameters 11 and 12 would be assigned to occasions 24 and 25.

If the number of occasions to be assigned parameters from other occasions are greater than the number of original parameters (e.g., c(“11:12*24:26”)), then the last original parameter is re-cycled. In the example c(“11:12*24:26”), the parameter for occasion 12 is assigned to occasions 25 and 26.


dataframe containing the parameter order by occasion.


Gary A. Nelson, Massachusetts Division of Marine Fisheries

See Also



fm_checkdesign(occasions=27, design=c("1*14","4*17","7*20","11*24"),type="F")

fishmethods documentation built on May 19, 2017, 10:50 a.m.
Search within the fishmethods package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.