read_pp_swift: Read processed Swift fixes from PinPoint Host software output

Description Usage Arguments Examples

View source: R/read_pp_swift.R

Description

This function reads the text file generated by the PinPoint Host software and generates a tidy data frame for further analysis. The user can optionally remove unsuccessful fixes.

Usage

1
2
read_pp_swift(swift_txt = NULL, out_tz = "America/New_York",
  valid_only = FALSE, deploy_df = NULL)

Arguments

swift_txt

character scalar or vector containing path(s) to the *.txt file created by the PinPoint Host software when processing Swift fixes. Default ('NULL') prompts the user to select one or more files.

out_tz

character string indicating the desired output timezone of the GPS fixes. Datetimes will be converted from the standard GMT time zone of PinPoint fixes. Default is America/New_York.

valid_only

logical indicating whether unsuccessful GPS fix attempts should be removed from the output data frame. The default (FALSE) retains the scheduled fixes that were unsuccessful.

deploy_df

'data.frame', 'tibble' or 'tbl_df' containing deployment and recovery information for PinPoint tags that will be used to filter tag data. This object must contain at least the following three variables: 'tag_id' - integer or numeric PinPoint tag identification number, 'deploy_date' - 'POSIXct' date of tag deployment, and 'recov_date' - 'POSIXct' date of tag recovery. Currently, data on the day of deployment and recovery are ignored.

Examples

1
2
3
4
5
6
## Not run: 
# Select apprpriate text files from file selection window that opens
pp_tests <- list.files(path = system.file("extdata", package = "pinpoint"), full.names = TRUE)
dat <- read_pp_swift(pp_tests)

## End(Not run)

adamdsmith/pinpoint documentation built on Aug. 12, 2021, 12:53 a.m.