The information below is outdated. We are working on an update.

Field definitions are managed in the ETN database, not in this package, but suggestions/corrections can be reported as an issue (see the contributing guide). The definitions are also available as a csv file.

## Animals

Related function: get_animals().

field definition example
tag_id Select a tag. A tag code space will only appear here after adding the tag metadata in the tab ‘Tags’. as in: A69-9004-2210
scientific_name Scientific name of animal that carries the tag. as in: Gadus morhua
common_name The species’ common English name. as in: Atlantic cod
aphia_id The Aphia ID linked to the scientific name. The Aphia ID can be found at http://www.marinespecies.org/aphia.php?p=webservice format: integer; as in: 126436
animal_label Identification code that uniquely identifies each animal, as specified by the researcher. as in: A82
animal_nickname Nickname given to the tagged animal. format: free text; as in: John
tagger Person conducting tagging as in: Pieterjan Verhelst
capture_date_time Date and time that animal was caught, in 24h UTC. Datetime fields should follow the ISO-8601 format. format: yyyy-mm-ddThh:mm:ssZ; as in: 2017-06-27T12:00:00Z
capture_location Name of capture location. Please refer to a specific nearby point of land, town, island, or body of water that uniquely identifies this tagging location. Okay to leave blank if same as release location. format: free text; as in: Reefballs C-Power
capture_latitude Latitude of capture location. Leave blank if same as release location. Note: in the southern hemisphere all latitudes must be negative. format: dd.ddddd; as in: 51.36324
capture_longitude Longitude of capture location. Leave blank if same as release location. Note: in the western hemisphere all longitudes must be negative. format: ddd.ddddd; as in: 2.59020
capture_method Name of the method and materials used to capture animal. format: free text; as in: line fishing
capture_depth Water depth at which the animal was caught. units: metres; format free text; as in: 25 m
capture_temperature_change Difference between water temperature of the system where the fish was caught and the water temperature of the holding reservoir. units: degrees celsius; as in: 5ºC
release_date_time Date and time that tagged animal was released, in UTC. format: yyyy-mm-ddThh:mm:ssZ; as in: 2016-04-04T12:30:00Z
release_location Name of release location. Please refer to a specific nearby point of land, town, island, or body of water that uniquely identifies this tagging location. as in: Reefballs C-Power
release_latitude Latitude of release location. Note: in the southern hemisphere all latitudes must be negative. format: dd.ddddd; as in: 51.36324
release_longitude Longitude of release location. Note: in the western hemisphere all longitudes must be negative. format: ddd.ddddd; as in: 2.59020
recapture_date_time If applicable, date of recapture of the tagged animal. format: yyyy-mm-ddThh:mm:ssZ; as in: 2017-07-10T12:00:00Z
length1_type Specify type of length recorded (e.g. hood length, fork length, standard length, etc.). format: free text; as in: total length
length1 Length of animal that carries tag, depending on ‘Length type’, in units specified in ‘Length units’. format: double; as in: 46.00
length1_unit Units of length. as in: cm
length2_type Specify type of secondary size measurement (e.g. width). format: free text; as in: horizontal eye diameter
length2 Secondary length measurement, depending on ‘Length2 type’, in units specified in ‘Length2 units’. format: double; as in: 9.50
length2_unit Units of secondary length. as in: mm
length3_type Specify type of tertiary size measurement (e.g. width). format: free text; as in: vertical eye diameter
length3 Tertiary length measurement, depending on ‘Length3 type’, in units specified in ‘Length3 units’. format: double; as in: 7.23
length3_unit Units of tertiary length. as in: mm
length4_type Specify type of quaternary size measurement (e.g. width). format: free text; as in: pectoral fin length
length4 Quaternary length measurement, depending on ‘Length4 type’, in units specified in ‘Length4 units’. format: double; as in 46.73
length4_unit Units of quaternary length. as in: mm
weight Weight of animal that carries tag, in units specified in ‘Weight units’. format: double; as in: 806.9
weight_unit Units of weight. as in: g
age Weight of animal that carries tag, the units are specified in ‘Age units’. format: integer; as in: 2
age_unit Units of age. as in: durif index
sex Sex of animal. M or F. Can enter unknown (U). as in: M
life_stage Life stage of animal. This will depend on the species being studied and can be a standard code used for that species, a description, or both. as in: FV
wild_or_hatchery Origin of animal that carries the tag. Enter wild, hatchery or unknown. as in: wild
stock Water body of origin. Can enter unknown or not applicable. as in: Southern Bight
surgery_date_time Date that surgery was conducted. Date fields should follow the ISO-8601 format. format: yyyy-mm-ddThh:mm:ssZ; as in: 2017-06-27T12:00:00Z
surgery_location Short name of surgery location (i.e. hatchery name). format: free text; as in: onboard RV
surgery_latitude Latitude of surgery location. Note: in the southern hemisphere all latitudes must be negative. format: dd.ddddd; as in: 51.36324
surgery_longitude Longitude of surgery location. Note: in the western hemisphere all longitudes must be negative. format: dd.ddddd; as in: 2.59020
treatment_type Contains a designation of treatment group as appropriate for the particular study. Researchers will have to contact the authors directly for definitions. Try to make these as clear as possible (e.g. use Control instead of C, Lake release instead of Lake). format: free text; as in: Control
tagging_type Indicates how tag was attached to animal (e.g. internal, external, oral, gastric, subcutaneous, etc.). as in: internal
tagging_methodology Describe method and materials used to attach tag to animal. as in: inserted into abdominal cavity through midventral line incision, closed using 2 polydioxanone monofilament sutures.
dna_sample Indicates whether the animal that carries the acoustic tag is also sampled for DNA. format: y or n; as in: y
sedative Name of sedative used if applicable. as in: aquacalm
sedative_concentration Concentration of sedative. format: free text; as in: 0.5 ml/l
anaesthetic Name of anaesthetic used if applicable. as in: Clove oil
buffer Name of buffer used if applicable. as in: Sodium Bicarbonate
anaesthetic_concentration Concentration of anaesthetic. format: free text; as in: 0.5 ml/l
buffer_concentration_in_anaesthetic Concentration of buffer in anaesthetic. format: free text; as in: 0.1 ml/l
anaesthetic_concentration_in_recirculation Concentration of anaesthetic in recirculation bath. format: free text; as in: 0.5 ml/l
buffer_concentration_in_recirculation Concentration of buffer in recirculation bath. format: free text; as in: 0.1 ml/l
dissolved_oxygen This measure is the lowest oxygen level the fish will experience during the surgery. format: free text; as in: 6 mg/l
pre_surgery_holding_period Time that animal is held prior to surgery. units: hours; as in: 0.5
post_surgery_holding_period Time the animal is held after surgery until release. units: hours; as in: 2
holding_temperature This measure is the highest or lowest water bath temperature the fish will experience during holding (depends if surgical water temperatures are increasing or decreasing relative to initial water temperature reading). For example, if tagging is being cond units: degrees celsius; as in: 5ºC
comments Any comments deemed to have scientific relevance by the tagger. format: free text

## Tags

Related function: get_tags().

field definition example
pk Primary Key linked to the tag. This field is automatically generated by the database when a new entry is made. as in: 1
tag_id_alternative Converted Code as in: A69-0001-00001
telemetry_type Type of tag attached to animal. Fixed options: Id-tag or sensor-tag as in: id-tag
frequency Frequency at which the tag emits a signal. units: Hz; as in: 069k
tag_id_protocol Tag code space of the detected tag. as in: S256 or A69-1105
tag_id_code In the case of an acoustic tag or Vemco mobile transceiver, this is the identification code transmitted by the tag, which is available from the tag manufacturer. as in: 1450
status Current status of the tag. Three options: available, active or ended. as in: active
activation_date_time Date and time the tag was activated, in UTC format: yyyy-mm-ddThh:mm:ssZ; as in: 2020-01-01T12:30:00
battery_estimated_life Estimated duration of time during which the tag will be transmitting. units: days; as in: 90
battery_estimated_end_date Estimated date at which tag will stop transmitting. Date fields should follow the ISO-8601 format. format: yyyy-mm-ddT; as in: 2017-06-27T
sensor_type Type of tag sensor. Predefined options: P, T or A. P = pressure, T = temperature, A = acceleration. as in: Pressure
sensor_slope Raw value of slope, as used for sensor calibration. format: double; as in: 0.1516
sensor_intercept Raw value of intercept, as used for sensor calibration. format: double; as in: -0.6065
sensor_range Maximum range of sensor. as in: 34
sensor_transmit_ratio Ratio of transmission between sensors present. If for example both a T and P sensor are present and T transmits twice as often as P, the range is 2 to 1. as in: 1
accelerometer_algorithm There are two possible modes of operation of the accelerometer algorithm: Activity or Tailbeat. as in: Activity
accelerometer_samples_per_second Number of acceleration samples taken on each axis per second. Sampling rate can be 5 Hertz (5 measurements/s) or 10 Hertz (10 measurements/s). units: Hertz; as in: 5
owner_pi First and last name of the Principal Investigator for the project. as in: Jan Reubens
financing_project Tag financing project. as in: project
step1_min_delay Minimum delay between the pings transmitted by the tag for step 1. units: seconds; as in: 30
step1_max_delay Maximum delay between the pings transmitted by the tag for step 1. units: seconds; as in: 60
step1_power Acoustic power level. H or L. as in: H
step1_duration Duration of step 1. units: days; as in: 120
step1_acceleration_duration Time window over which acceleration is sampled (in seconds). units: seconds, as in: 37
step2_min_delay Minimum delay between the pings transmitted by the tag for step 2. units: seconds; as in: 30
step2_max_delay Maximum delay between the pings transmitted by the tag for step 2. units: seconds; as in: 60
step2_power Acoustic power level. H or L. as in: L
step2_duration Duration of step 2. units: days; as in: 120
step2_acceleration_duration Time window over which acceleration is sampled (in seconds). units: seconds, as in: 37
step3_min_delay Minimum delay between the pings transmitted by the tag for step 3. units: seconds; as in: 30
step3_max_delay Maximum delay between the pings transmitted by the tag for step 3. units: seconds; as in: 60
step3_power Acoustic power level. H or L. as in: H
step3_duration Duration of step 3. units: days; as in: 360
step3_acceleration_duration Time window over which acceleration is sampled (in seconds). units: seconds, as in: 37
step4_min_delay Minimum delay between the pings transmitted by the tag for step 4. units: seconds; as in: 30
step4_max_delay Maximum delay between the pings transmitted by the tag for step 4. units: seconds; as in: 60
step4_power Acoustic power level. H or L. as in: H
step4_duration Duration of step 4. units: days; as in: 360
step4_acceleration_duration Time window over which acceleration is sampled (in seconds). units: seconds, as in: 37

## Detections

Related function: get_detections().

field definition example
pk Technical identifier of the detection record in the database.
date_time Date and time at which the tagged animal was detected at the receiver. Information from detection file. format: yyyy-mm-ddThh:mm:ssZ; as in: 2017-06-27T12:00:00Z
receiver_id Receiver name, composed of ‘Model number’-‘Serial number’. Info comes from ‘Detection_table’. as in: VR2W-103255
application_type
network_project_code Code of the network project linked to this detection. as in: BPNS
tag_id Tag ID of the detected tag. as in: A69-1010-12345
tag_fk Foreign key linked to the tag.
animal_id Foreign Key linked to the Animal_ID
animal_project_code Code of the animal project linked to this detection. as in: BPNS
scientific_name Scientific name of the animal that carries the tag. as in: Anguilla anguilla or Gadus morhua
station_name Name of receiver station. The station name refers to a unique location, related to a specific latitude and longitude. as in: Reefballs
deploy_latitude Latitude of the location of the deployment. format: dd.ddddd; as in: 51.32098
deploy_longitude Longitude of the location of the deployment. format: ddd.ddddd; as in: 3.13661
sensor_type Type of tag sensor. Predefined options: P, T or A. P = pressure, T = temperature, A = acceleration. as in: Pressure
sensor_value Value recorded by the tag sensor. as in: 35 or 0.13
sensor_unit Unit of measured sensor value. as in: P
sensor_value_depth Value recorded by the pressure sensor. as in: 15
sensor_value_acceleration Value recorded by the acceleration sensor. as in: 0.13
sensor_value_temperature Value recorded by the temperature sensor. as in: 15
signal_to_noise_ratio Signal-to-noise ratio. This is the difference between the background noise level and the signal level. Info comes from detection file.
source_file Name of the detection file.
qc_flag Identifies whether there are quality check issues for the given detection.
deployment_fk Foreign key linked to the deployment information

## Deployments

Related function: get_deployments().

field definition example
receiver_id Receiver ID linked to the deployment. Composed by ‘Model number’-‘Serial number’. as in: TBR700-234
station_name Name of the station where the deployment of the receiver takes place. Related to a specific latitude and longitude. format: free text; as in: OH6
station_description Name of receiver location. The location name serves as an additional descriptive name of the receiver station. It can refer to a specific nearby point of land, town, island, or body of water that identifies this receiver location. as in: upstream weir
station_manager Name of the person or institution managing the location. as in: Jan Reubens
deploy_date_time Date and time that the equipment was deployed, in 24-hour UTC. Corresponds to the time of the captured waypoint. Datetime fields should follow the ISO-8601 format (e.g. 2017-01-01T12:07:23Z) format: yyyy-mm-ddThh:mm:ssZ; as in: 2017-06-27T12:00:00Z
deploy_latitude Latitude of the actual deployment location, in decimal degrees. Note: in the southern hemisphere all latitudes must be negative. format: dd.ddddd; as in: 51.36324
deploy_longitude Longitude of the actual deployment location, in decimal degrees. Note: in the western hemisphere all longitudes must be negative. format: ddd.ddddd; as in: 2.59020
intended_latitude Latitude of the intended deployment location, in decimal degrees. Note: in the southern hemisphere all latitudes must be negative. format: dd.ddddd; as in: 51.36324
intended_longitude Longitude of the intended deployment location, in decimal degrees. Note: in the western hemisphere all longitudes must be negative. format: ddd.ddddd; as in: 2.59020
mooring_type Type of mooring to which the receiver is attached. Predefined options: surface-buoy, surface-wind-turbine or bottom-mooring. as in: surface-wind-turbine, surface-buoy or bottom-mooring
bottom_depth Depth at deployment location as recorded by the vessel’s depth sounder. units: metres; format: integer; as in: 25
riser_length Length from the anchor to the topmost float or structure of the mooring assembly. units: metres; format: integer; as in: 10
deploy_depth Depth of the instrument. units: metres; format: integer; as in: 20
battery_installation_date Date when the receiver was fitted with fresh batteries. format: yyyy-mm-dd; as in: 2017-06-27
battery_estimated_end_date Estimated date at which receiver will stop recording. This date is calculated automatically from (Deployments/Battery install date) and (Receivers/Expected battery life). format: yyyy-mm-dd hh:mm; as in: 2017-06-04 00:00
recover_date_time Date and time that the equipment was recovered, in 24-hour UTC. ISO-8601 format. format: yyyy-mm-ddThh:mm:ssZ; as in: 2017-06-27T12:00:00Z
recover_latitude Latitude where the equipment was recovered, in decimal degrees. Unless it is found a substantial distance from its expected location, this can be left blank. For failed recovery attempts, use this field to record the central latitude of the recovery sea. format: dd.ddddd; as in: 51.36324
recover_longitude Longitude where the equipment was recovered, in decimal degrees. Unless it is found a substantial distance from its expected location, this can be left blank. For failed recovery attempts, use this field to record the central longitude of the recovery sea format: ddd.ddddd; as in: 2.59020
download_date_time Date and time that data were downloaded, in 24-hour UTC. format: yyyy-mm-dd hh:mm; as in: 2017-06-27 12:00
download_file_name Were data downloaded? Yes or no. If no, please add comment. format: y or n; as in: y
sync_date_time Date and time when a receiver’s clock is synchronized to correct UTC, in 24-hour UTC. ISO-8601 format. format: yyyy-mm-ddThh:mm:ssZ; as in: 2017-06-27T12:00:00Z
time_drift Displayed difference in time between the instrument’s clock and correct UTC. Note: This must be recorded in the field for Vemco model VR3 receivers when there are no detections because no log file is created under those circumstances. format: hh:mm:ssZ; as in: 12:00:00Z
ar_battery_installation_date Date when the acoustic release was fitted with fresh batteries, in 24-hour UTC format. format: yyyy-mm-dd; as in: 2017-06-27
ar_confirm Did the acoustic release report a confirmed release? Yes or no. format: y or n; as in: y
transmit_profile Predefined options: Range test(random), Range test(90s) or Sync. as in: Sync
transmit_power_output Predefined options: Low, Medium, High, Very high. as in: High
log_temperature_stats_period Time interval between the recording of temperature statistic, as calculated from sample values. units: seconds; format: integer; as in: 3600
log_temperature_sample_period Time interval between the sample values of temperature. This field is specific to VR2AR receivers. By default, sample values are not logged on the VR2AR receivers. units: seconds; format: integer; as in: 21600
log_tilt_sample_period Time interval between the sample values of tilt. This field is specific to VR2AR receivers. units: seconds; format: integer; as in: 600
log_noise_stats_period Time interval between the recording of noise statistic, as calculated from sample values. units: seconds; format: integer; as in: 600
log_noise_sample_period Time interval between the sample values of noise. This field is specific to VR2AR receivers. By default, sample values are not logged on the VR2AR receivers. units: seconds; format: integer; as in: 600
log_depth_stats_period Time interval between the recording of depth statistic, as calculated from sample values. units: seconds; format: integer; as in: 600
log_depth_sample_period Time interval between the sample values of depth. This field is specific to VR2AR receivers. By default, sample values are not logged on the VR2AR receivers. units: seconds; format: integer; as in: 3600
comments Any comments deemed to have scientific relevance by the tagger. format: free text

Related function: get_receivers().

field definition example
pk Primary Key linked to the tag. This field is automatically generated by the database when a new entry is made. as in: 1
receiver_id The receiver name is composed of ‘Model number’-‘Serial number’. as in: VR2W-120620
application_type The receiver context type as in: CPOD or Acoustic
manufacturer Name of receiver manufacturer. Predefined options: VEMCO, CHELONIA or THELMA. as in: Vemco
receiver_id_model Receiver model number as provided by the manufacturer. as in: VR2W
receiver_id_serial_number Serial number assigned by receiver manufacturer to uniquely identify receiver. as in: 106252
modem_address This field is mandatory for Vemco VR4UWM receivers. It is a three-digit code from 001 to 249, as provided by the manufacturer, that is used to communicate with the Benthos modem. For VR4 receivers manufactured prior to September 2011, the modem address is format: 3-digit code from 001 to 249; as in 121
status Current status of receiver. Predefined options: Active, Available, Broken, Lost or Returned to manufacturer. as in: Active or Lost
battery_estimated_life Expected duration for which the battery will provide adequate power for proper functioning of the receiver. units: months; format: integer; as in: 12
owner_organisation Affiliation of the Principal Investigator for the project. as in: VLIZ
financing_project Receiver financing project. as in: project
built_in_tag_id Tag full ID of the receiver’s built in tag. as in: A69-1601-60508
ar_model_number Model number of the acoustic release as provided by the manufacturer. as in: 867
ar_serial_number Serial number of the acoustic release as provided by the manufacturer. as in: 48635
ar_battery_estimated_life Expected duration for which the battery will provide adequate power for proper functioning of the acoustic release. units: months; format: integer; as in: 12
ar_voltage_at_deploy Voltage reported by an acoustic release as near as possible to the time of deployment. units: volt; format: double; as in: 12.2
ar_interrogate_code Interrogate code or code range command of the release. Used to ping a specific release, rather than send a general ping to all releases in the vicinity. format: integer; as in: 1003
ar_receive_frequency Interrogate or receive frequency at which the release receives data. units: kHz; as in: 7.75
ar_reply_frequency Frequency at which the release sends data. units: kHz; as in: 10
ar_ping_rate Ping rate of the release. units: seconds; format: integer; as in: 1
ar_enable_code_address Code used to enable the release; differs among release models. format: free text; as in: G; as in: 68
ar_release_code Code used to release the release; differs among release models. format: free text; as in: A; as in: 12345
ar_disable_code Code used to disable the release. format: free text; as in: H
ar_tilt_code Tilt code of the release. format: free text; as in: B
ar_tilt_after_deploy Tilt after deploy of receiver format: integer; as in: 1003