motusSearchTags: return a list of all motus tags

In jbrzusto/motusServer: Operate a server to process data for http://motus.org

Description

return a list of all motus tags

Usage

motusSearchTags(projectID = NULL, tsStart = NULL, tsEnd = NULL,
  searchMode = "startsBetween", mfgID = NULL, status = NULL,
  tsLastModified = NULL, ...)

Arguments

projectID:	integer scalar; motus internal project ID
tsStart:	numeric scalar; unix timestamp; start of active period
tsEnd:	numeric scalar; unix timestamp; end of active period
searchMode:	character scalar; type of search desired. "overlap" looks for tags active during at least a portion of the time span c(tsStart, tsEnd), while "startsBetween" looks for tags with deployment start times in the same range.
mfgID:	character scalar; typically a small integer; return only records for tags with this manufacturer ID (usually printed on the tag)
status:	integer; if non-NULL, returns only tags with the specified status. 1L = tag finished; 2L = tag active; 0L = tag not yet deployed
tsLastModified:	numeric scalar; unix timestamp; metadata modification threshold; if not NULL, only records modified since tsLastModified are returned. Allows us to update the tagDeps records in the metadata cache.
...:	additional parameters to motusQuery()

Value

the data.frame of motus tags and their meta data satisfying the search criteria, or NULL if there are none. The data.frame has these columns:

• tagID

• projectID

• mfgID

• dateBin

• type

• codeSet

• manufacturer

• model

• lifeSpan

• nomFreq

• offsetFreq

• period

• periodSD

• pulseLen

• param1

• param2

• param3

• param4

• param5

• param6

• param7

• param8

• tsSG

• approved

• deployID

• status

• tsStart

• tsEnd

• deferSec

• speciesID

• markerNumber

• markerType

• latitude

• longitude

• elevation

• comments

Note

As of 2018-08-24, filtering by 'tsStart' and 'tsEnd' fails to return any tags whose 'tsEnd' is NULL; see https://github.com/MotusDev/MotusAPI/issues/8

support for tsLastModified is pending, so specifying it currently returns data.frame()

Author(s)

John Brzustowski jbrzusto@REMOVE_THIS_PART_fastmail.fm

jbrzusto/motusServer documentation built on May 19, 2019, 8:19 a.m.