PIFSC-Protected-Species-Division / LTabundR

R package for design-based line-transect density estimation
https://pifsc-protected-species-division.github.io/LTabundR-vignette/
Creative Commons Zero v1.0 Universal
0 stars 0 forks source link

Remove `ss_correction` input for `lta()`? #4

Closed ericmkeen closed 3 months ago

ericmkeen commented 6 months ago

The lta() function has an input, ss_correction, that adjusts the group size of all sightings. This was included in order to maintain all features from the original NOAA code base. But what is the use of this input? Is the use case so rare that we can remove it from this function, just for a measure of simplicity?

ALB asked:

"Should we say something more about why this is included here instead of in cohort-specific settings (similar to reason provided for use_g0? Going back to cohort settings, everything there related to calibration coefficients. I'm not sure if anyone would want to add a fixed correction by cohort, but perhaps they only wanted to scale small odontocetes, is there a way to do that? If not, should we say that?"

EK asked:

"I'm not familiar with why this setting exists. It was something in Jay's code that I included in LTabundR for the sake of completeness. Would it simplify things if we excluded this? (Users could manipulate data on their own if they really need to, without us baking this manipulation into the package function.) What do you think?"

ericmkeen commented 3 months ago

I've removed the ss_correction input; there was no known reason for keeping it, and in the rare circumstance in which an analyst needs to scale all group sizes by some coefficient then they can easily do so to the cruz object on their own. This update will be a part of the version 1.2 release.