tagme: update a motus tag detection database

Description Usage Arguments Value Author(s) See Also Examples

Description

update a motus tag detection database

Usage

1
2
tagme(projRecv, update = TRUE, new = FALSE, dir = getwd(),
  countOnly = FALSE, forceMeta = FALSE)

Arguments

projRecv

integer scalar project code from motus.org, *or* character scalar receiver serial number

update

boolean scalar: should any new data be downloaded and merged? default: TRUE, unless this is a new database (in which case you must specify update=TRUE explicitly).

new

logical scalar: is this a new database? Default: FALSE You have to specify new=TRUE if you want a new local copy of the database to be created. Otherwise, tagme() assumes the database already exists, and will stop with an error if it cannot find it in the current directory. This is mainly to prevent inadvertent downloads of large amounts of data that you already have!

countOnly

logical scalar: if FALSE, the default, then do requested database updates. Otherwise, return a count of items that would need to be transferred in order to update the database.

forceMeta

logical scalar: if true, re-get metadata for tags and receivers, even if we already have them.

dir:

path to the folder where you are storing databases Default: the current directory; i.e. getwd()

Value

a dplyr::src_sqlite for the (possibly updated) database, or a list of counts if countOnly==TRUE

Author(s)

John Brzustowski jbrzusto@REMOVE_THIS_PART_fastmail.fm

See Also

tellme, which is a synonym for tagme(..., update=TRUE, countOnly=TRUE)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
## create and open a local tag database for motus project 14 in the
## current directory

# t = tagme(14, new=TRUE)

## update and open the local tag database for motus project 14;
## it must already exist and be in the current directory

# t = tagme(14, update=TRUE)

## update and open the local tag database for a receiver;
## it must already exist and be in the current directory

# t = tagme("SG-1234BBBK4567", update=TRUE)

## open the local tag database for a receiver, without
## updating it

# t = tagme("SG-1234BBBK4567")

## open the local tag database for a receiver, but
## tell 'tagme' that it is in a specific directory

# t = tagme("SG-1234BBBK4567", dir="Projects/gulls")

## update all existing project and receiver databases in \code{dir}
# tagme()

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