motus.org

getParamOverrides

R Documentation

Get the parameter overrides for a receiver and time or boot session.

Description

Get the parameter overrides for a receiver and time or boot session.

Usage

getParamOverrides(serno, monoBN = NULL, tsStart = NA,
  progName = "find_tags_motus", recvDepTol = 10 * 24 * 3600,
  motusProjectID = NULL)

Arguments

`serno`	character scalar; serial number of receiver, e.g. "Lotek-123" or "SG-5133BBBK2972"
`monoBN`	integer scalar; boot session for which we want the overrides; (ignored if `serno` is a Lotek receiver
`tsStart`	real scalar; starting timestamp for which we want the overrides; (ignored if `serno` is a sensorgnome)
`progName`	program name for which the parameters are sought; Default: "find_tags_motus"
`recvDepTol`	numeric scalar; how much slop is allowed when looking up the project ID for a receiver? Sometimes, people have recorded incorrect start of deployment dates, and/or the estimate of boot session time is inaccurate. Default: 10243600 which is 10 days.
`motusProjectID`	integer scalar; if supplied, and if no appropriate deployment record can be found for the receiver, this is used to look-up project-based parameter overrides.

Value

a character scalar of parameters, ready for the command line; if there are no applicable overrides, returns ""

Note

Overrides come from the paramOverrides table of the motus meta database. As of 2016 Dec 14, this database is just copied from /sgm/paramOverrides.sqlite, but eventually motus will provide user-editable fields for these.

An override can be specified for either a whole project, or for a receiver. In both cases, the override period can be specified as well. A receiver-specific override will override a project-wide override, if both are applicable.

If no deployment record can be found for the receiver, the specified motusProjectID is used to look-up project-specific parameter overrides. see: https://github.com/jbrzusto/motusServer/issues/406