motusSearchTags: return a list of motus tags

Description Usage Arguments Value Author(s)

Description

return a list of motus tags

Usage

1
2
3
4
motusSearchTags(projectID = NULL, tsStart = NULL, tsEnd = NULL,
  searchMode = c("startsBetween", "overlaps"), defaultLifespan = 90,
  lifespanBuffer = 1.5, regStart = NULL, regEnd = NULL, mfgID = NULL,
  ...)

Arguments

projectID:

integer scalar; motus internal project ID

tsStart:

numeric scalar; start of active period

tsEnd:

numeric scalar; end of active period

searchMode:

character scalar; type of search desired. "overlaps" 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.

defaultLifeSpan:

integer scalar; default lifespan of tags, in days; used when motus does not know the lifespan for a tag.

lifeSpanBuffer:

numeric scalar; amount by which nominal lifespan is multiplied to get maximum possible lifespan.

regStart:

numeric scalar; if not NULL, search for tags registered no earlier than this date, and ignore deployment dates.

regEnd:

numeric scalar; if not NULL, search for tags registered no later than this date, and ignore deployment dates.

mfgID:

character scalar; typically a small integer; return only records for tags with this manufacturer ID (usually printed on the tag)

...:

additional parameters to motusQuery()

Value

the list of motus tags and their meta data satisfying the search criteria, or NULL if there are none.

Author(s)

John Brzustowski jbrzusto@REMOVE_THIS_PART_fastmail.fm


jbrzusto/motusClient documentation built on May 30, 2019, 4:33 p.m.