import_argos: Import, process, and export data from Argos downloads

View source: R/import_argos.R

import_argosR Documentation

Import, process, and export data from Argos downloads

Description

Import, process, and export data from Argos downloads

Usage

import_argos(
  UPLOAD = FALSE,
  FORMAT.ARGOS = TRUE,
  SPEED.FILTER = TRUE,
  argos.csv.path,
  argos.processed.file,
  export.file,
  log.file,
  tz = "GMT"
)

Arguments

UPLOAD

logical; if TRUE, then an existing, formatted file housed at the path specified by argos.processed.file is already available. Only the newest files will be appended to this existing data set. If FALSE, all downloads from the ARGOS server that occurred after 1 Jan 1980 will be imported and formatted. Please contact the package maintainer if this date needs to be changed

FORMAT.ARGOS

logical, default is TRUE see format_argos for more details

SPEED.FILTER

logical, default is TRUE. see speed_filter for more details

argos.csv.path

character; the path to the Argos data

argos.processed.file

character; the file that contains the already- processed data to be appended to the newly processed data

export.file

character; the file to which to export the data

log.file

character; the PTT log file

tz

character; time zone to pass to datetime functions. Default is 'GMT'

Details

todo

Value

A data frame with the processed Argos data

Examples


## Not run: 
# Run for all new data
x <- import_argos(
  UPLOAD = FALSE, FORMAT.ARGOS = TRUE, SPEED.FILTER = TRUE,
  argos.csv.path = "processing/input",
  argos.processed.file = "",
  export.file = "ArgosData_2022_01_20_02_13_00_output.csv",
  log.file = "PTTlog.csv"
)

# Run with already-processed data
x <- import_argos(
  UPLOAD = FALSE, FORMAT.ARGOS = TRUE, SPEED.FILTER = TRUE,
  argos.csv.path = "processing/input",
  argos.processed.file = "ArgosData_##_output.csv",
  export.file = "ArgosData_2022_01_20_02_13_00_output.csv",
  log.file = "PTTlog.csv"
)

## End(Not run)


us-amlr/amlrgos documentation built on Nov. 10, 2024, 7:30 a.m.