ABbiodiversity / wildRtrax

wildrtrax is an R package for environmental sensor data management and analytics
https://abbiodiversity.github.io/wildRtrax/
Other
8 stars 9 forks source link

`wt_qpad_offsets` `together` argument works opposite to what I expected #43

Closed see24 closed 5 months ago

see24 commented 8 months ago

When together = TRUE get just offsets and when together = FALSE get dataframe with offsets attached which is opposite to what I expected from the argument name and docs.

library(wildRtrax)
library(dplyr)

# Start by getting everything you need
Sys.setenv(WT_USERNAME = 'guest', WT_PASSWORD = 'Apple123')
wt_auth()
#> Authentication into WildTrax successful.
my_report <- wt_download_report(project_id = 605, sensor_id = 'ARU', reports = "main", weather_cols = F) %>%
  tibble::as_tibble()

my_tidy_data <- wt_tidy_species(my_report, remove = "mammal", zerofill=F)

my_tmtt_data <- wt_replace_tmtt(data = my_tidy_data, calc = "round")

my_wide_data <- wt_make_wide(data = my_tmtt_data, sound = "all")
#> Warning: There was 1 warning in `mutate()`.
#> ℹ In argument: `individual_count = case_when(grepl("^C", individual_count) ~
#>   NA_real_, TRUE ~ as.numeric(individual_count))`.
#> Caused by warning:
#> ! NAs introduced by coercion

# When together is True we get just offsets returned
my_offset_data <- wt_qpad_offsets(data = my_wide_data, species = "all", 
                                  version = 3, together = TRUE)

colnames(my_offset_data)
#>  [1] "ALFL" "AMCR" "AMRE" "AMRO" "ATSP" "ATTW" "BAWW" "BBMA" "BBWA" "BBWO"
#> [11] "BCCH" "BHCO" "BHVI" "BLJA" "BOCH" "BOWA" "BRCR" "CCSP" "CEDW" "CHSP"
#> [21] "CMWA" "COGR" "CONW" "CORA" "COYE" "CSWA" "DEJU" "DOWO" "EVGR" "GCKI"
#> [31] "GRCA" "GRYE" "HAWO" "HETH" "HOWR" "LCSP" "LEFL" "LEYE" "LISP" "MAWA"
#> [41] "MAWR" "MODO" "MOWA" "NOFL" "NOWA" "OCWA" "OSFL" "OVEN" "PAWA" "PHVI"
#> [51] "PIGR" "PISI" "PIWO" "PUFI" "RBGR" "RBNU" "RCKI" "RECR" "REVI" "RUGR"
#> [61] "RWBL" "SAVS" "SEWR" "SOSA" "SOSP" "SPGR" "SPSA" "SWSP" "SWTH" "TEWA"
#> [71] "VATH" "WAVI" "WETA" "WEWP" "WISN" "WIWA" "WIWR" "WTSP" "WWCR" "YBFL"
#> [81] "YBSA" "YEWA" "YHBL" "YRWA"

# And when it is False get offsets attached to data
my_offset_data <- wt_qpad_offsets(data = my_wide_data, species = "all", 
                                  version = 3, together = FALSE)

colnames(my_offset_data)
#>   [1] "organization"        "project_id"          "location"           
#>   [4] "location_id"         "location_buffer_m"   "longitude"          
#>   [7] "latitude"            "equipment_make"      "equipment_model"    
#>  [10] "recording_id"        "recording_date_time" "task_id"            
#>  [13] "aru_task_status"     "task_duration"       "task_method"        
#>  [16] "ALFL"                "AMBI"                "AMCO"               
#>  [19] "AMCR"                "AMRE"                "AMRO"               
#>  [22] "AMWI"                "ATSP"                "ATTW"               
#>  [25] "BADO"                "BAWW"                "BBMA"               
#>  [28] "BBWA"                "BBWO"                "BCCH"               
#>  [31] "BHCO"                "BHVI"                "BLJA"               
#>  [34] "BLTE"                "BOCH"                "BOGU"               
#>  [37] "BOOW"                "BOWA"                "BRCR"               
#>  [40] "BWTE"                "CACI"                "CAJA"               
#>  [43] "CANG"                "CCSP"                "CEDW"               
#>  [46] "CHIK"                "CHSP"                "CMWA"               
#>  [49] "COGO"                "COGR"                "COLO"               
#>  [52] "COME"                "CONI"                "CONW"               
#>  [55] "CORA"                "CORE"                "COTE"               
#>  [58] "COYE"                "CSWA"                "DEJU"               
#>  [61] "DOWO"                "DUGR"                "EVGR"               
#>  [64] "FRGU"                "GADW"                "GCKI"               
#>  [67] "GHOW"                "GRCA"                "GRYE"               
#>  [70] "GWFG"                "GWTE"                "HAWO"               
#>  [73] "HETH"                "HEWI"                "HOWR"               
#>  [76] "LCSP"                "LEFL"                "LEYE"               
#>  [79] "LIAI"                "LIBA"                "LINO"               
#>  [82] "LIRA"                "LISP"                "LITF"               
#>  [85] "LIWI"                "MALL"                "MAWA"               
#>  [88] "MAWR"                "MOAI"                "MOBA"               
#>  [91] "MODO"                "MONO"                "MORA"               
#>  [94] "MOTF"                "MOWA"                "MOWI"               
#>  [97] "NHOW"                "NOFL"                "NOPO"               
#> [100] "NOWA"                "NSHO"                "NSWO"               
#> [103] "OCWA"                "OSFL"                "OVEN"               
#> [106] "PALO"                "PAWA"                "PAWR"               
#> [109] "PBGR"                "PHVI"                "PIGR"               
#> [112] "PISI"                "PIWO"                "PSFL"               
#> [115] "PUFI"                "RBGR"                "RBNU"               
#> [118] "RCKI"                "RECR"                "REVI"               
#> [121] "RNGR"                "RUGR"                "RWBL"               
#> [124] "SACR"                "SAVS"                "SEWR"               
#> [127] "SORA"                "SOSA"                "SOSP"               
#> [130] "species"             "SPGR"                "SPSA"               
#> [133] "STGR"                "SWSP"                "SWTH"               
#> [136] "TEWA"                "TRUS"                "UNAM"               
#> [139] "UNBI"                "UNBL"                "UNBT"               
#> [142] "UNDU"                "UNFL"                "UNGO"               
#> [145] "UNKN"                "UNOW"                "UNPA"               
#> [148] "UNSH"                "UNSP"                "UNTH"               
#> [151] "UNTR"                "UNWA"                "UNWO"               
#> [154] "UNYE"                "VATH"                "WAVI"               
#> [157] "WETA"                "WEWP"                "WISN"               
#> [160] "WIWA"                "WIWR"                "WTSP"               
#> [163] "WWCR"                "YBFL"                "YBSA"               
#> [166] "YERA"                "YEWA"                "YHBL"               
#> [169] "YRWA"                "ALFL.off"            "AMCR.off"           
#> [172] "AMRE.off"            "AMRO.off"            "ATSP.off"           
#> [175] "ATTW.off"            "BAWW.off"            "BBMA.off"           
#> [178] "BBWA.off"            "BBWO.off"            "BCCH.off"           
#> [181] "BHCO.off"            "BHVI.off"            "BLJA.off"           
#> [184] "BOCH.off"            "BOWA.off"            "BRCR.off"           
#> [187] "CCSP.off"            "CEDW.off"            "CHSP.off"           
#> [190] "CMWA.off"            "COGR.off"            "CONW.off"           
#> [193] "CORA.off"            "COYE.off"            "CSWA.off"           
#> [196] "DEJU.off"            "DOWO.off"            "EVGR.off"           
#> [199] "GCKI.off"            "GRCA.off"            "GRYE.off"           
#> [202] "HAWO.off"            "HETH.off"            "HOWR.off"           
#> [205] "LCSP.off"            "LEFL.off"            "LEYE.off"           
#> [208] "LISP.off"            "MAWA.off"            "MAWR.off"           
#> [211] "MODO.off"            "MOWA.off"            "NOFL.off"           
#> [214] "NOWA.off"            "OCWA.off"            "OSFL.off"           
#> [217] "OVEN.off"            "PAWA.off"            "PHVI.off"           
#> [220] "PIGR.off"            "PISI.off"            "PIWO.off"           
#> [223] "PUFI.off"            "RBGR.off"            "RBNU.off"           
#> [226] "RCKI.off"            "RECR.off"            "REVI.off"           
#> [229] "RUGR.off"            "RWBL.off"            "SAVS.off"           
#> [232] "SEWR.off"            "SOSA.off"            "SOSP.off"           
#> [235] "SPGR.off"            "SPSA.off"            "SWSP.off"           
#> [238] "SWTH.off"            "TEWA.off"            "VATH.off"           
#> [241] "WAVI.off"            "WETA.off"            "WEWP.off"           
#> [244] "WISN.off"            "WIWA.off"            "WIWR.off"           
#> [247] "WTSP.off"            "WWCR.off"            "YBFL.off"           
#> [250] "YBSA.off"            "YEWA.off"            "YHBL.off"           
#> [253] "YRWA.off"

Created on 2024-01-04 with reprex v2.0.2