getMovebankReferenceTable: Download all reference data of a Movebank study

Description

This function returns the information of the animals, tags, deployments and sensors from a Movebank study

Usage

getMovebankReferenceTable(study, login, allAttributes = FALSE)

Arguments

study

character or numeric. Character: full name of the study, as stored on Movebank. Numeric: Movebank ID of the study which can be obtained on the Study Details page on Movebank or with getMovebankID.

a MovebankLogin object, if empty you'll be asked to enter your username and password

allAttributes

logical. If FALSE the output will only include the attributes that currently contain information in the study (default). If TRUE the output will include all attributes available on Movebank.

Value

'data.frame'

Details

getMovebankReferenceTable belongs to the Movebank browsing functions and returns a data.frame from the requested study, including all data provided by the user referring to the animals, tags and deployments. It also includes animal_id, tag_id, deployment_id, sensor_type_id, study_id which are the internal ids of Movebank. This table is equivalent to the table obtained on the Movebank webpage trough the option "Download Reference Data" of the study.

Examples

Run this code

# NOT RUN {
# obtain a login
login <- movebankLogin()
getMovebankReferenceTable(study=74496970, login=login)[1:6,]
getMovebankReferenceTable(study=74496970, login=login, allAttributes=T)[1:6,]
# }