-
Notifications
You must be signed in to change notification settings - Fork 5
/
check.R
1388 lines (1249 loc) · 60.7 KB
/
check.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#' check.R arguments
#'
#' @param arrays a list containing information for each array.
#' @param bio A table with the tags and biometrics of the studied animals.
#' @param deployments a list of deployments.
#' @param detections The detections data.frame for a specific tag.
#' @param detections.list A list of the detections split by each target tag,
#' created by \code{\link{splitDetections}}.
#' @param dist.mat A distances matrix.
#' @param discard.orphans Logical: Should actel automatically discard
#' detections that do not fall within receiver deployment periods, or that
#' were recorded before the respective animals were released?
#' @param dotmat The matrix of distances between arrays.
#' @param GUI One of "needed", "always" or "never". If "needed", a new window is
#' opened to inspect the movements only if the movements table is too big to be
#' displayed in R's console. If "always", a graphical interface is always created
#' when the possibility to invalidate events emerges. If "never", a graphical
#' interface is never invoked. In this case, if the table to be displayed does
#' not fit in R's console, a temporary file will be saved and the user will be
#' prompted to open and examine that file. Defaults to "needed".
#' @param movements The movements table for a specific tag.
#' @param n A string indicating the overall progress.
#' @param release The release location of the animal.
#' @param secmoves the section movements list.
#' @param spatial A list of spatial objects in the study area.
#' @param tag The tag being analysed.
#' @param unknown.receivers serial number of the receivers to be included.
#' @param valid.movements The valid movements table for a specific tag.
#'
#' @name check_args
#' @keywords internal
#'
NULL
#' Check argument quality
#'
#' @param dp A preloaded datapack (or NULL if no data was preloaded).
#' @inheritParams explore
#' @inheritParams migration
#' @inheritParams residency
#'
#' @keywords internal
#'
#' @return updated parameters
#'
checkArguments <- function(dp, tz, min.total.detections, min.per.event, max.interval, speed.method = c("last to first", "last to last", "first to first"),
speed.warning, speed.error, start.time, stop.time, report, auto.open, save.detections, jump.warning, jump.error,
inactive.warning, inactive.error, exclude.tags, override, print.releases, detections.y.axis = c("auto", "stations", "arrays"),
if.last.skip.section = NULL, replicates = NULL, section.warning, section.error, section.order = NULL, timestep = c("days", "hours")) {
appendTo("debug", "Running checkArguments.")
# Note: Checks only relevant for migration() or residency() are listed at the bottom!
no.dp.args <- c("tz", "section.order", "start.time", "stop.time", "save.detections", "exclude.tags")
link <- c(!is.null(tz),
!is.null(section.order),
!is.null(start.time),
!is.null(stop.time),
!(is.logical(save.detections) && !save.detections), !is.null(exclude.tags))
if (!is.null(dp) & any(link))
appendTo(c("Screen", "Warning", "Report"), paste0("Argument", ifelse(sum(link) > 1, "s '", " '"), paste(no.dp.args[link], collapse = "', '"),
ifelse(sum(link) > 1, "' were ", "' was "), "set but a datapack was provided. Disregarding set arguments."))
if (is.null(dp) & is.null(tz))
stopAndReport('argument "tz" is missing, with no default')
if (is.null(dp) && is.na(match(tz, OlsonNames())))
stopAndReport("'tz' could not be recognized as a time zone. Check available time zones with OlsonNames()")
if (!is.numeric(min.total.detections))
stopAndReport("'min.total.detections' must be numeric.")
if (!is.numeric(min.per.event))
stopAndReport("'min.per.event' must be numeric.")
if (min.total.detections <= 0)
stopAndReport("'min.total.detections' must be positive.")
if (any(min.per.event <= 0))
stopAndReport("'min.per.event' must be positive.")
if (length(min.per.event) == 1)
min.per.event <- rep(min.per.event, 2)
if (!is.numeric(max.interval))
stopAndReport("'max.interval' must be numeric.")
if (max.interval <= 0)
stopAndReport("'max.interval' must be positive.")
if (max.interval < 10)
appendTo(c("Screen", "Warning"), "Setting 'max.interval' to less than 10 minutes is not recommended!\n This can lead to the creation of an immense number of movement events,\n which will be hardly manageable if any quality check is triggered.")
if (!is.character(speed.method))
stopAndReport("'speed.method' should be one of 'last to first', 'last to last', or 'first to first'.")
speed.method <- match.arg(speed.method)
if (!is.null(speed.warning) && !is.numeric(speed.warning))
stopAndReport("'speed.warning' must be numeric.")
if (!is.null(speed.warning) && speed.warning <= 0)
stopAndReport("'speed.warning' must be positive.")
if (!is.null(speed.error) && !is.numeric(speed.error))
stopAndReport("'speed.error' must be numeric.")
if (!is.null(speed.error) && speed.error <= 0)
stopAndReport("'speed.error' must be positive.")
if (!is.null(speed.error) & is.null(speed.warning))
speed.warning <- speed.error
if (!is.null(speed.error) && speed.error < speed.warning)
stopAndReport("'speed.error' must not be lower than 'speed.warning'.")
if (!is.null(speed.warning) & is.null(speed.error))
speed.error <- Inf
if (is.null(dp) && !is.null(start.time) && !grepl("^[1-2][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-5][0-9]", start.time))
stopAndReport("'start.time' must be in 'yyyy-mm-dd hh:mm:ss' format.")
if (is.null(dp) && !is.null(stop.time) && !grepl("^[1-2][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-5][0-9]", stop.time))
stopAndReport("'stop.time' must be in 'yyyy-mm-dd hh:mm:ss' format.")
if (!is.logical(report))
stopAndReport("'report' must be logical.")
if (!is.logical(auto.open))
stopAndReport("'auto.open' must be logical.")
if (is.null(dp) && !is.logical(save.detections))
stopAndReport("'save.detections' must be logical.")
if (!is.numeric(jump.warning))
stopAndReport("'jump.warning' must be numeric.")
if (jump.warning < 1)
stopAndReport("'jump.warning' must not be lower than 1.")
if (!is.numeric(jump.error))
stopAndReport("'jump.error' must be numeric.")
if (jump.error < 1)
stopAndReport("'jump.error' must not be lower than 1.")
if (jump.error < jump.warning) {
if (jump.warning == 2) { # this happens if someone changed jump error but didn't set jump warning.
appendTo(c("screen", "warning"), "Adjusting default 'jump.warning' to match set 'jump.error'.")
jump.warning <- jump.error
} else {
if (jump.error == 3) { # this happens if someone changed jump warning but didn't change jump error.
appendTo(c("screen", "warning"), "Adjusting default 'jump.error' to match set 'jump.warning'.")
jump.error <- jump.warning
} else { # this happens if someone set both jump warning and jump error. In this case, stop and let the user decide.
stopAndReport("'jump.error' must not be lower than 'jump.warning'.")
}
}
}
if (!is.null(inactive.warning) && !is.numeric(inactive.warning))
stopAndReport("'inactive.warning' must be numeric.")
if (!is.null(inactive.warning) && inactive.warning <= 0)
stopAndReport("'inactive.warning' must be positive.")
if (!is.null(inactive.error) && !is.numeric(inactive.error))
stopAndReport("'inactive.error' must be numeric.")
if (!is.null(inactive.error) && inactive.error <= 0)
stopAndReport("'inactive.error' must be positive.")
if (!is.null(inactive.error) & is.null(inactive.warning))
inactive.warning <- inactive.error
if (!is.null(inactive.error) && inactive.error < inactive.warning)
stopAndReport("'inactive.error' must not be lower than 'inactive.warning'.")
if (!is.null(inactive.warning) & is.null(inactive.error))
inactive.error <- Inf
if (is.null(dp) && !is.null(exclude.tags) && any(!grepl("-", exclude.tags, fixed = TRUE)))
stopAndReport("Not all contents in 'exclude.tags' could be recognized as tags (i.e. 'codespace-signal'). Valid examples: 'R64K-1234', 'A69-1303-1234'")
if (!is.null(override) && is.numeric(override)) {
appendTo(c('report', 'screen', 'warning'), 'Override is numeric (i.e. the code space has not been included). Will attempt to identify tags to be excluded based on signal alone.')
}
if (!is.logical(print.releases))
stopAndReport("'print.releases' must be logical.")
if (!is.character(detections.y.axis))
stopAndReport("'detections.y.axis' should be one of 'stations' or 'arrays'")
detections.y.axis <- match.arg(detections.y.axis)
# Check that all the overridden tags are part of the study
if (!is.null(dp) && !is.null(override)) {
if (is.numeric(override)) {
lowest_signals <- sapply(dp$bio$Signal, lowestSignal)
if (any(link <- is.na(match(override, dp$bio$Signal)))) {
stopAndReport("Some tags listed in 'override' (", paste0(override[link], collapse = ", "), ") are not listed in the biometrics data.")
}
} else {
if (any(link <- is.na(match(override, dp$bio$Transmitter)))) {
stopAndReport("Some tags listed in 'override' (", paste0(override[link], collapse = ", "), ") are not listed in the biometrics data.")
}
}
}
# NON-explore checks
if (!is.character(timestep))
stopAndReport("'timestep' should be one of 'days' or 'hours'")
timestep <- match.arg(timestep)
if (!is.null(section.order) && any(table(section.order) > 1))
stopAndReport("Some section names are duplicated in the 'section.order' argument. Please include each section only once.")
if (!is.null(if.last.skip.section) && !is.logical(if.last.skip.section))
stopAndReport("'if.last.skip.section' must be logical.")
if (!is.null(replicates) && !is.list(replicates))
stopAndReport("'replicates' must be a list.")
if (!is.null(replicates) && length(names(replicates)) != length(replicates))
stopAndReport("All list elements within 'replicates' must be named (i.e. list(Array = 'St.1') rather than list('St.1')).")
# only run these in residency calls.
if (!missing(section.warning)) {
if (section.error > section.warning) {
if (section.warning == 1) { # this happens if someone changed section error but didn't set section warning.
appendTo(c("screen", "warning"), "Adjusting default 'section.warning' to match set 'section.error'.")
section.warning <- section.error
} else {
if (section.error == 1) { # this happens if someone changed section warning but didn't change section error.
appendTo(c("screen", "warning"), "Adjusting default 'section.error' to match set 'section.warning'.")
section.error <- section.warning
} else { # this happens if someone set both section warning and section error. In this case, stop and let the user decide.
stopAndReport("'section.error' must not be lower than 'section.warning'.")
}
}
}
if (min.per.event[2] > section.error)
appendTo(c('screen', 'warning', 'report'), "The minimum number of detections per valid section event is higher than 'section.warning'. Section warnings will never occur.")
if (min.per.event[2] > section.error)
appendTo(c('screen', 'warning', 'report'), "The minimum number of detections per valid section event is higher than 'section.error'. Section errors will never occur.")
} else {
# placeholder values so that explore and migration don't crash when attempting
# to export below. These two variables are only used by residency.
section.error <- 0
section.warning <- 0
}
return(list(min.per.event = min.per.event,
speed.method = speed.method,
speed.warning = speed.warning,
speed.error = speed.error,
jump.warning = jump.warning,
jump.error = jump.error,
inactive.warning = inactive.warning,
inactive.error = inactive.error,
detections.y.axis = detections.y.axis,
section.warning = section.warning,
section.error = section.error,
timestep = timestep))
}
#' Verify that the source data has been compiled using actel's preload function
#'
#' @param token The token generated by preload
#' @param timestamp The time when the token was issued
#'
#' @keywords internal
#'
#' @return No return value. Called for side effects.
#'
checkToken <- function(token, timestamp) {
appendTo("debug", "Running checkToken.")
if (file.exists(paste0(tempdir(), "/actel_token_list.csv")))
x <- read.csv(paste0(tempdir(), "/actel_token_list.csv"))
else
x <- NULL
if ((is.null(token) | is.null(timestamp) | is.null(x)) || !any(x$Token == token & x$Timestamp == timestamp))
stopAndReport("The datapack's token is invalid or missing. Please the function preload() to compile the input data.\nAdditionally, data must to be compiled during the current R session.")
}
#' Check if the dependencies required to open a GUI are installed, and if
#' opening a GUI does not throw an error. Some code adapted from RGtk2's
#' .onLoad function.
#'
#' @inheritParams check_args
#'
#' @keywords internal
#'
#' @return An updated GUI argument (character string)
#'
#'
checkGUI <- function(GUI = c("needed", "always", "never"), save.tables.locally) {
appendTo("debug", "Running checkGUI.")
if (!is.character(GUI))
stopAndReport("'GUI' should be one of 'needed', 'always' or 'never'.")
GUI <- match.arg(GUI)
if (GUI != "never" && length(suppressWarnings(packageDescription("gWidgets2tcltk"))) == 1) {
appendTo(c("Screen", "Warning"), paste0("GUI is set to '", GUI, "' but package 'gWidgets2tcltk' is not available. Please install it if you intend to run GUI.\n Disabling GUI (i.e. GUI = 'never') for the current run."))
GUI <- "never"
}
if (GUI == "never" & save.tables.locally & file.exists("actel_inspect_movements.csv"))
stopAndReport("GUI is set to 'never' and save.tables.locally is set to TRUE, but a file 'actel_inspect_movements.csv' already exists in the current work directory.\n Stopping to prevent data loss. Delete/rename the existing 'actel_inspect_movements.csv' to be able to run this analysis.")
if (GUI == "never" & save.tables.locally & file.exists("actel_inspect_detections.csv"))
stopAndReport("GUI is set to 'never' and save.tables.locally is set to TRUE, but a file 'actel_inspect_detections.csv' already exists in the current work directory.\n Stopping to prevent data loss. Delete/rename the existing 'actel_inspect_detections.csv' to be able to run this analysis.")
return(GUI)
}
#' Check if there are duplicated detection in the input data
#'
#' @param input The detections data frame
#'
#' @return The detections data frame, without duplicated detections.
#'
#' @keywords internal
#'
checkDupDetections <- function(input) {
appendTo("debug", "Running checkDupDetections.")
paired <- data.frame(
TimestampA = input$Timestamp[-nrow(input)],
TimestampB = input$Timestamp[-1],
ReceiverA = input$Receiver[-nrow(input)],
ReceiverB = input$Receiver[-1],
TransmitterA = input$Transmitter[-nrow(input)],
TransmitterB = input$Transmitter[-1]
)
if (any(colnames(input) == "Source.file")) {
paired$Source.FileA <- input$Source.file[-nrow(input)]
paired$Source.fileB <- input$Source.file[-1]
}
dups <- c(FALSE, paired[,1] == paired[,2] & paired[,3] == paired[,4] & paired[,5] == paired[,6])
if (any(dups)) {
appendTo(c("Screen", "Report", "Warning"), paste0(sum(dups), " duplicated detection", ifelse(sum(dups) == 1, " was", "s were"), " found. Could an input file be duplicated?"))
message("")
message("Possible options:\n a) Stop and double-check the data\n b) Remove duplicated detections\n c) Continue without changes\n d) Save duplicated detections to a file and re-open dialogue.")
message("")
restart <- TRUE
while (restart) {
decision <- userInput("Decision:(a/b/c/d) ", choices = letters[1:4], hash = "# dup. detections")
if (decision == "a")
stopAndReport("Function stopped by user command.") # nocov
if (decision == "b") {
appendTo(c("Screen", "Report"), "M: Removing duplicated detections from the analysis per user command.")
output <- input[!dups, ]
restart <- FALSE
}
if (decision == "c") { # nocov start
appendTo(c("Screen", "Report"), "M: Continuing analysis with duplicated detections per user command.")
output <- input
restart <- FALSE
} # nocov end
if (decision == "d") { # nocov start
file.name <- userInput("Please specify a file name (leave empty to abort saving): ", hash = "# save dups to this file")
# break if empty
if (file.name == "")
next()
# confirm extension
if (!grepl("\\.csv$", file.name))
file.name <- paste0(file.name, ".csv")
# prevent auto-overwrite
if (file.exists(file.name)) {
aux <- userInput(paste0("File '", file.name, "' already exists. Overwrite contents?(y/n) "),
choices = c("y", "n"),
hash = "# overwrite file with same name?")
if (aux == "y")
overwrite <- TRUE
else
overwrite <- FALSE
}
else
overwrite <- TRUE
# save
if (overwrite) {
success <- TRUE
# recover if saving fails
tryCatch(data.table::fwrite(paired[dups[-1], ], file.name, , dateTimeAs = "write.csv"), error = function(e) {
appendTo(c("Screen", "Report"), paste0("Error: Could not save file (reason: '", sub("\n$", "", e), "').\n Reopening previous interaction."))
success <<- FALSE
})
if (success)
appendTo(c("Screen", "Report"), paste0("M: A copy of the duplicated detections has been saved to '", file.name, "'.\n Reopening previous interaction."))
}
} # nocov end
}
} else {
output <- input
}
return(output)
}
#' Check the number of detections (total and per event) of a given tag. Works
#' for both array and section movements.
#'
#' @inheritParams check_args
#' @inheritParams explore
#'
#' @return A data frame containing the movements with valid/invalid notes
#'
#' @keywords internal
#'
checkMinimumN <- function(movements, min.total.detections, min.per.event, tag, n) {
appendTo("debug", "Running checkMinimumN")
if (sum(movements$Detections) < min.total.detections) {
appendTo(c("screen", "report", "warning"), paste0("Tag ", tag, " ", n, " has less than ", min.total.detections," detections in total. Discarding this tag."))
movements$Valid <- FALSE # invalidate the tag
}
if (any(movements$Valid) & any(movements$Detections < min.per.event)) {
if (any(colnames(movements) == 'Array'))
appendTo(c("screen", "report", "warning"), paste0("Tag ", tag, " ", n, " has ", tolower(colnames(movements)[1]), " movement events with less than ", min.per.event, " detections. Invalidating those events."))
movements$Valid[movements$Detections < min.per.event] <- FALSE
}
return(movements)
}
#' check tag speeds against defined thresholds (in m/s)
#'
#' @inheritParams check_args
#' @inheritParams explore
#'
#' @return A list of movements with updated 'Valid' columns
#'
#' @keywords internal
#'
checkSpeeds <- function(movements, tag, detections, valid.movements,
speed.warning, speed.error, GUI, save.tables.locally, n) {
appendTo("debug", "Running checkSpeeds.")
the.warning <- NULL
vm <- valid.movements
warning.counter <- 0
if (any(na.as.false(vm$Average.speed.m.s >= speed.warning))) {
link <- which(vm$Average.speed.m.s >= speed.warning)
if (link[1] == 1) {
appendTo(c("Report", "Warning", "Screen"),
the.warning <- paste0("Tag ", tag, " ", n, " had an average speed of ", round(vm$Average.speed.m.s[1], 2),
" m/s from release to first valid event (Release -> ", vm$Array[1], ")."))
the.warning <- paste("Warning:", the.warning)
link <- link[-1]
warning.counter <- warning.counter + 1
}
if (length(link) > 0) {
for (i in 1:length(link)) {
warning.counter <- warning.counter + 1
if (warning.counter < 5) {
appendTo(c("Report", "Warning", "Screen"),
other.warning <- paste0("Tag ", tag, " ", n, " had an average speed of ", round(vm$Average.speed.m.s[link[i]], 2),
" m/s from valid event ", link[i] - 1, " to ", link[i], " (",vm$Array[link[i] - 1], " -> ", vm$Array[link[i]], ")."))
other.warning <- paste("Warning:", other.warning)
the.warning <- paste0(the.warning, "\n", other.warning)
} else {
final.warning <- paste0("Warning: Tag ", tag, " ", n, " had an average speed higher than ", speed.warning, " m/s in ", warning.counter, " events (of which the first 4 are displayed above).")
message(paste0("\r", final.warning), appendLF = FALSE); flush.console()
}
}
if (warning.counter >= 5) {
message()
appendTo(c("Report", "Warning"), sub("Warning: ", "", final.warning))
link <- createEventRanges(link)
appendTo(c("Screen", "Report"), event.list <- paste0(" Events that raised warnings: ", paste(link, collapse = ", ")))
the.warning <- paste0(the.warning, "\n", final.warning, "\n", event.list)
}
}
}
# Trigger user interaction
if (any(na.as.false(vm$Average.speed.m.s >= speed.error))) { # nocov start
movements <- tableInteraction(moves = movements, tag = tag, detections = detections,
trigger = the.warning, GUI = GUI, save.tables.locally = save.tables.locally)
} # nocov end
return(movements)
}
#' Find if a tag is standing still in an array
#'
#' @inheritParams check_args
#' @inheritParams explore
#'
#' @return A list of movements with updated 'Valid' columns
#'
#' @keywords internal
#'
checkInactiveness <- function(movements, tag, detections, n,
inactive.warning, inactive.error, dist.mat, GUI, save.tables.locally) {
Valid <- NULL
appendTo("debug", "Running checkInactiveness.")
if (any(movements$Valid)) {
valid.moves <- movements[(Valid)]
# Find first and last potentially inactive movement
breaks <- rle(valid.moves$Array)
if(length(breaks$lengths) > 1) {
Start <- sum(breaks$lengths[1:(length(breaks$lengths) - 1)]) + 1
} else {
Start <- 1
}
Stop <- nrow(valid.moves)
# Fetch respective detection rows
valid.row.list <- lapply(Start:Stop, function(j) {
Start <- min(which(detections$Timestamp == valid.moves$First.time[j] & detections$Standard.name == valid.moves$First.station[j]))
Stop <- Start + (valid.moves$Detections[j] - 1)
return(Start:Stop)
})
# Start trimming from the Start to see if a period of inactiveness is present
continue <- TRUE
iteration <- 1
while (continue) {
the.warning <- NULL
# count days spent to compare with arguments
start_i <- Start + iteration - 1
# Stop if we have reached the end of the possible iterations
if (start_i > Stop)
break()
days.spent <- round(as.numeric(difftime(valid.moves$Last.time[Stop], valid.moves$First.time[start_i], units = "days")), 2)
# Stop if the days.spent are lesser than enough to trigger a warning
if (days.spent < inactive.warning)
break()
valid.rows <- unlist(valid.row.list[iteration:length(valid.row.list)])
the.detections <- detections[valid.rows, ]
# find all stations
the.stations <- as.character(sort(unique(the.detections$Standard.name)))
trigger.error <- FALSE
# Trigger warning
if (attributes(dist.mat)$valid) {
aux <- dist.mat[the.stations, the.stations]
if (all(aux <= 1500)) {
n.detections <- sum(valid.moves$Detections[start_i:Stop])
appendTo(c("Report", "Warning", "Screen"),
the.warning <- paste0("Tag ", tag, " ", n, " was detected ", n.detections,
" times at stations less than 1.5 km apart in array '", tail(breaks$values, 1),
"' (", paste(the.stations, collapse = ", "), "), over ", days.spent,
" days and then disappeared. Could it be inactive?"))
the.warning <- paste("Warning:", the.warning)
continue <- FALSE
}
if (all(aux <= 1500) & days.spent >= inactive.error)
trigger.error <- TRUE # nocov
} else {
if (length(the.stations) <= 3) {
n.detections <- sum(valid.moves$Detections[start_i:Stop])
appendTo(c("Report", "Warning", "Screen"),
the.warning <- paste0("Tag ", tag, " ", n, " was detected ", n.detections,
" times at three or less stations of array '", tail(breaks$values, 1),
"' (", paste(the.stations, collapse = ", "), ") over ", days.spent,
" days and then disappeared. Could it be inactive?"))
the.warning <- paste("Warning:", the.warning)
continue <- FALSE
}
if (length(the.stations) <= 3 & days.spent >= inactive.error)
trigger.error <- TRUE # nocov
}
# Trigger user interaction
if (trigger.error) { # nocov start
appendTo("Screen", error.message <- paste0("M: Tag ", tag, " ", n, " has been inactive for more than ", inactive.error," days. Inactiveness started on event ", start_i, " (", as.Date(valid.moves$First.time[start_i]),")."))
movements <- tableInteraction(moves = movements, tag = tag, detections = detections,
trigger = paste0(the.warning, "\n", error.message), GUI = GUI,
save.tables.locally = save.tables.locally)
} # nocov end
iteration <- iteration + 1
}
}
return(movements)
}
#' Find out if a tag moved in an impossible direction
#'
#' @inheritParams check_args
#'
#' @return A list of movements with updated 'Valid' columns
#'
#' @keywords internal
#'
checkImpassables <- function(movements, tag, bio, spatial, detections, dotmat, GUI, save.tables.locally, n){
appendTo("debug", "Running checkImpassables.")
Valid <- NULL
release <- as.character(bio$Release.site[na.as.false(bio$Transmitter == tag)])
release <- unlist(strsplit(with(spatial, release.sites[release.sites$Standard.name == release, "Array"]), "|", fixed = TRUE))
restart <- TRUE
first.time <- TRUE
while (restart) {
restart <- FALSE
warning.counter <- 0
the.warning <- NULL
valid.moves <- movements[(Valid)]
if (!first.time) {
message("------------------------------------")
appendTo(c("Screen", "Warning"), "The last interaction did not solve the impassable problem! See remaining problems below.\n You can also press ESC to abort the current run and alter your spatial.txt file.")
message("------------------------------------")
}
# check release movement
if (sum(movements$Valid) > 0) {
if(all(is.na(dotmat[as.character(release), as.character(valid.moves$Array[1])]))) {
appendTo(c("Screen", "Warning", "Report"), the.warning <- paste0("Tag ", tag, " ", n, " made an impassable jump: It is not possible to go from release site ", as.character(release), " to ", as.character(valid.moves$Array[1]), ".\n Please resolve this either by invalidating events or by adjusting your 'spatial.txt' file and restarting."))
the.warning <- paste("Warning:", the.warning)
warning.counter <- warning.counter + 1
}
}
# check other movements
if (sum(movements$Valid) > 1) {
shifts <- data.frame(
A = valid.moves$Array[-nrow(valid.moves)],
B = valid.moves$Array[-1])
distances <- apply(shifts, 1, function(x) dotmat[x[1], x[2]])
if (any(is.na(distances))) {
for (i in which(is.na(distances))) {
warning.counter <- warning.counter + 1
if (warning.counter < 5) {
appendTo(c("Screen", "Warning", "Report"), other.warning <- paste0("Tag ", tag, " ", n, " made an impassable jump in events ", i," to ", i + 1, ": It is not possible to go from array ", shifts[i, 1], " to ", shifts[i, 2], "."))
other.warning <- paste("Warning:", other.warning)
the.warning <- paste0(the.warning, "\n", other.warning)
} else {
final.warning <- paste0("Warning: Tag ", tag, " made ", warning.counter, " impassable jumps (of which the first 4 are displayed above).")
message(paste0("\r", final.warning), appendLF = FALSE); flush.console()
}
}
if (warning.counter >= 5) {
message("")
appendTo(c("Report", "Warning"), sub("Warning: ", "", final.warning))
link <- createEventRanges(which(is.na(distances)))
appendTo(c("Screen", "Report"), event.list <- paste0(" Events that raised warnings: ", paste(link, collapse = ", ")))
the.warning <- paste0(the.warning, "\n", final.warning, "\n", event.list)
}
}
}
if (!is.null(the.warning)) {
message("Please resolve this either by invalidating events or by adjusting your 'spatial.txt' file and restarting.")
if (interactive()) { # nocov start
the.warning <- paste(the.warning, "\nPlease resolve this either by invalidating events or by adjusting your 'spatial.txt' file and restarting.", collapse = "\n")
movements <- tableInteraction(moves = movements, tag = tag, detections = detections,
trigger = the.warning, GUI = GUI, force = TRUE,
save.tables.locally = save.tables.locally)
restart <- TRUE
first.time <- FALSE
} else { # nocov end
stop("Preventing analysis from entering interactive mode in a non-interactive session.")
}
}
}
return(movements)
}
#' Verify number of detections in section movements
#'
#' @inheritParams check_args
#' @inheritParams residency
#'
#' @return A list of section movements with updated 'Valid' columns
#'
#' @keywords internal
#'
checkSMovesN <- function(secmoves, tag, section.warning, section.error, GUI, save.tables.locally, n) {
appendTo("debug", "Running checkSMovesN.")
if (any(secmoves$Detections <= section.warning & secmoves$Valid)) {
the.warning <- paste0("Section movements with ", section.warning, " or less detections are present for tag ", tag, " ", n, ".")
appendTo(c("Screen", "Report", "Warning"), the.warning)
}
if (any(secmoves$Detections <= section.error & secmoves$Valid)) {
secmoves <- tableInteraction(moves = secmoves, tag = tag, trigger = the.warning, # nocov
GUI = GUI, save.tables.locally = save.tables.locally) # nocov
}
return(secmoves)
}
#' Check that the tag linearly moved along the sections
#'
#' @inheritParams check_args
#' @inheritParams migration
#'
#' @return A list of section movements with updated 'Valid' columns
#'
#' @keywords internal
#'
checkLinearity <- function(secmoves, tag, spatial, arrays, GUI, save.tables.locally, n) {
appendTo("debug", "Running checkLinearity.")
valid.secmoves <- secmoves[secmoves$Valid, ]
sections <- names(spatial$array.order)
back.check <- match(valid.secmoves$Section, sections)
turn.check <- rev(match(sections, rev(valid.secmoves$Section))) # captures the last event of each section. Note, the values count from the END of the events
if (is.unsorted(back.check)) {
if (is.unsorted(turn.check, na.rm = TRUE))
appendTo(c("Screen", "Report", "Warning"), the.warning <- paste0("Inter-section backwards movements were detected for tag ", tag, " ", n, " and the last events are not ordered!"))
else
appendTo(c("Screen", "Report", "Warning"), the.warning <- paste0("Inter-section backwards movements were detected for tag ", tag, " ", n, "."))
if (interactive()) { # nocov start
secmoves <- tableInteraction(moves = secmoves, tag = tag, trigger = the.warning,
GUI = GUI, force = FALSE, save.tables.locally = save.tables.locally)
} # nocov end
}
return(secmoves)
}
#' Check report compatibility
#'
#' Checks if pandoc is up and running and creates a "Report" folder, if necessary
#'
#' @inheritParams explore
#'
#' @return An updated report argument (logical)
#'
#' @keywords internal
#'
checkReport <- function(report){
appendTo("debug", "Running checkReport.")
if (report) {
appendTo("Report", "M: 'report' option has been activated.")
if (!rmarkdown::pandoc_available()) {
appendTo(c("Screen", "Report", "Warning"), "'report' can only be activated if pandoc is installed. You can find how to install pandoc at: https://pandoc.org/installing.html\n You can also check if pandoc is available to R by running rmarkdown::pandoc_available()")
message("Would you like to:\n\n a) Stop the analysis and install pandoc.\n b) Continue with 'report' set to FALSE\n")
decision <- userInput("Decision:(a/b) ", choices = letters[1:2], hash = "# pandoc warning")
if (decision == "a")
stopAndReport("Analysis stopped per user command.")
if (decision == "b") {
appendTo(c("Screen", "Report", "Warning"), "Deactivating 'report' to prevent function failure.")
report <- FALSE
}
}
}
return(report)
}
#' Check for movements upstream of the release site.
#'
#' @inheritParams check_args
#'
#' @return A data frame with the movements for the target tag with updated 'Valid' column.
#'
#' @keywords internal
#'
checkFirstDetBackFromRelease <- function(movements, tag, bio, detections, arrays, spatial, GUI, save.tables.locally, n) {
appendTo("debug", "Running checkFirstDetBackFromRelease.")
# NOTE: The NULL variables below are actually column names used by data.table.
# This definition is just to prevent the package check from issuing a note due unknown variables.
Valid <- NULL
Array <- NULL
release <- as.character(bio$Release.site[na.as.false(bio$Transmitter == tag)])
release <- unlist(strsplit(with(spatial, release.sites[release.sites$Standard.name == release, "Array"]), "|", fixed = TRUE))
the.warning <- NULL
after.arrays <- unique(c(release, unlist(lapply(release, function(x) arrays[[x]]$all.after.and.par))))
if (any(movements$Valid))
vm <- movements[(Valid)]
else
return(movements)
if (any(is.na(match(vm$Array, after.arrays)))) {
appendTo(c("Screen", "Report", "Warning"), the.warning <- paste0("Tag ", tag, " ", n, " was detected in an array that is not after its release site! Opening relevant data for inspection.\nExpected first array: ", release))
the.warning <- paste("Warning:", the.warning)
if (interactive()) { # nocov start
movements <- tableInteraction(moves = movements, tag = tag, detections = detections,
trigger = the.warning, GUI = GUI, save.tables.locally = save.tables.locally)
} # nocov end
}
return(movements)
}
#' Check if tags are jumping over arrays
#'
#' @inheritParams check_args
#' @inheritParams explore
#'
#' @return A list of movements with updated 'Valid' columns
#'
#' @keywords internal
#'
checkJumpDistance <- function(movements, tag, bio, detections, spatial, arrays,
dotmat, paths, jump.warning, jump.error, GUI, save.tables.locally, n) {
appendTo("debug", "Running checkJumpDistance.")
# NOTE: The NULL variables below are actually column names used by data.table.
# This definition is just to prevent the package check from issuing a note due unknown variables.
Valid <- NULL
the.warning <- NULL
warning.counter <- 0
events.to.complain.about <- NULL
release <- as.character(bio$Release.site[na.as.false(bio$Transmitter == tag)])
release <- unlist(strsplit(with(spatial, release.sites[release.sites$Standard.name == release, "Array"]), "|", fixed = TRUE))
release.time <- bio$Release.date[na.as.false(bio$Transmitter == tag)]
if (any(movements$Valid)) {
vm <- movements[(Valid)]
#########################
# CHECK RELEASE TO FIRST
#########################
# remove any potential first array that is not connected do the first move (this should never happen, but still...)
release <- release[!is.na(dotmat[as.character(release), as.character(vm$Array[1])])]
# stop if no arrays are connected to the first move. This should also never happen actually.
if (length(release) == 0)
stopAndReport("There are unresolved impassable jumps in the movements (Found at release).")
# minimum jump size
release.steps <- min(dotmat[as.character(release), as.character(vm$Array[1])] + 1)
# Check release-to-first
if (release.steps > 1) {
# determine if any arrays were not active during the movement.
path.dist <- list()
for (r in release) {
sub.paths <- paths[[paste0(r, "_to_", vm$Array[1])]]
if (is.null(sub.paths)) { # failsafe in case step size is 2
aux <- list(list(n = 2, names = r))
} else {
aux <- lapply(sub.paths, function(p) {
xarrays <- unlist(strsplit(p, " -> "))
xarrays <- sapply(xarrays, function(a) {
# if the movement ocurred before the start
v1 <- arrays[[a]]$live$Start > release.time &
arrays[[a]]$live$Start > vm$First.time[1]
# or after the stop
v2 <- arrays[[a]]$live$Stop < release.time &
arrays[[a]]$live$Stop < vm$First.time[1]
# then that period does not qualify
v3 <- !(v1 | v2)
# and if any period qualifies, then the array was up during the movememnt
any(v3)
})
return(list(n = sum(xarrays) + 2, names = names(xarrays)[xarrays]))
# +2 because the release site and the array that picked up the animal also
# count as steps, so the minimal step size is two.
})
}
names(aux) <- sub.paths
path.dist <- c(path.dist, aux)
rm(aux)
}
new.steps <- sapply(path.dist, function(x) x$n)
release.steps <- min(new.steps)
say.at.least <- min(new.steps) != max(new.steps)
rm(new.steps)
}
if (release.steps > jump.warning) {
# Trigger warning
appendTo(c("Report", "Warning", "Screen"),
the.warning <- paste0("Tag ", tag, " ", n, " jumped through ",
ifelse(say.at.least, "at least ", ""), release.steps - 1,
ifelse(release.steps > 2, " arrays ", " array "),
"from release to first valid event (Release -> ", vm$Array[1], ")."))
the.warning <- paste("Warning:", the.warning)
warning.counter <- warning.counter + 1
events.to.complain.about <- c(events.to.complain.about, 1)
rm(say.at.least)
}
if (release.steps > jump.error)
trigger.error <- TRUE # nocov
else
trigger.error <- FALSE
#########################
# CHECK EVENT TO EVENT
#########################
if (nrow(vm) > 1) {
A <- vm$Array[-nrow(vm)]
B <- vm$Array[-1]
aux <- cbind(A, B)
move.steps <- apply(aux, 1, function(x) dotmat[x[1], x[2]])
names(move.steps) <- paste(A, "->", B)
if (any(is.na(move.steps)))
stopAndReport("There are unresolved impassable jumps in the movements (Found during moves).")
if (any(move.steps > 1)) {
# isolate troublesome events
steps.to.check <- which(move.steps > 1)
# confirm that arrays were active
for (i in steps.to.check) {
sub.paths <- paths[[paste0( vm$Array[i], "_to_", vm$Array[i + 1])]]
path.dist <- lapply(sub.paths, function(p) {
xarrays <- unlist(strsplit(p, " -> "))
xarrays <- sapply(xarrays, function(a) {
# if the movement ocurred before the start
v1 <- arrays[[a]]$live$Start > vm$Last.time[i] &
arrays[[a]]$live$Start > vm$First.time[i + 1]
# or after the stop
v2 <- arrays[[a]]$live$Stop < vm$Last.time[i] &
arrays[[a]]$live$Stop < vm$First.time[i + 1]
# then that period does not qualify
v3 <- !(v1 | v2)
# and if any period qualifies, then the array was up during the movememnt
any(v3)
})
return(list(n = sum(xarrays) + 1, names = names(xarrays)[xarrays]))
# +1 because the target array also counts as a step
})
names(path.dist) <- sub.paths
new.steps <- sapply(path.dist, function(x) x$n)
move.steps[i] <- min(new.steps)
say.at.least <- min(new.steps) != max(new.steps)
if (move.steps[i] > jump.warning) { # because ">", then if jump.warning = 1, actel only complains if steps = 2.
warning.counter <- warning.counter + 1
events.to.complain.about <- c(events.to.complain.about, i + 1)
if (warning.counter < 5) {
# Trigger warning
appendTo(c("Report", "Warning", "Screen"),
other.warning <- paste0("Tag ", tag, " ", n, " jumped through ",
ifelse(say.at.least, "at least ", ""), move.steps[i] - 1,
ifelse(move.steps[i] > 2, " arrays ", " array "),
"in valid events ", i, " -> ", i + 1, " (", names(move.steps)[i], ")."))
other.warning <- paste("Warning:", other.warning)
the.warning <- paste0(the.warning, "\n", other.warning)
} else {
final.warning <- paste0("Warning: Tag ", tag, " ", n, " jumped ", jump.warning, " or more arrays on ", warning.counter, " occasions (of which the first 4 are displayed above).")
message(paste0("\r", final.warning), appendLF = FALSE); flush.console()
}
}
rm(say.at.least)
if (move.steps[i] > jump.error) { # same as if above.
trigger.error <- TRUE # nocov
}
}
if (warning.counter >= 5) {
message("")
appendTo(c("Report", "Warning"), sub("Warning: ", "", final.warning))
link <- createEventRanges(events.to.complain.about)
appendTo(c("Screen", "Report"), event.list <- paste0(" Events that raised warnings: ", paste(link, collapse = ", ")))
the.warning <- paste0(the.warning, "\n", final.warning, "\n", event.list)
}
}
}
# Trigger user interaction
if (interactive() && trigger.error) { # nocov start
movements <- tableInteraction(moves = movements, tag = tag, detections = detections,
trigger = the.warning, GUI = GUI, save.tables.locally = save.tables.locally)
} # nocov end
}
return(movements)
}
#' Confirm that receivers were not re-deployed before being retrieved
#'
#' @param input The table of deployments
#'
#' @return No return value, called for side effects.
#'
#' @keywords internal
#'
checkDeploymentTimes <- function(input) {
appendTo("debug", "Running checkDeploymentTimes.")
aux <- split(input, input$Receiver)
for (i in 1:length(aux)) {
if (nrow(aux[[i]]) > 1) {
A <- aux[[i]]$Start[-1]
B <- aux[[i]]$Stop[-nrow(aux[[i]])]
AtoB <- as.numeric(difftime(A, B))
if (any(AtoB < 0)) {
appendTo(c("Screen", "Report"), paste0("Error: Receiver ", names(aux)[i], " was re-deployed before being retrieved:\n"))
aux[[i]][, "Bleh"] <- ""
aux[[i]][c(FALSE, AtoB < 0), "Bleh"] <- " <- !!!"
names(aux[[i]])[ncol(aux[[i]])] <- ""
message(paste0(capture.output(aux[[i]])[-1], collapse = "\n"))
message("")
stopAndReport("Fatal exception found. Read lines above for more details.")
}
}
}
}
#' Confirm that the station names in the deployments table match those listed in the spatial file
#'
#' @param input The table of deployments
#' @inheritParams check_args
#'
#' @return A data frame with the deployment locations
#'
#' @keywords internal
#'
checkDeploymentStations <- function(input, spatial) {
appendTo("debug","Running checkDeploymentStations.")
aux <- spatial[spatial$Type == "Hydrophone", ]
link <- match(unique(input$Station.name), aux$Station.name)
if (any(is.na(link))) {
appendTo(c("Screen", "Report", "Warning"),
paste0("The following station", ifelse(sum(is.na(link)) > 1, "s are", " is"),
" listed in the deployments but ",
ifelse(sum(is.na(link)) > 1, "are", "is"),
" not part of the study's stations: '",
paste(unique(input$Station.name)[is.na(link)], collapse = "', '"),
"'\nDiscarding deployments at unknown stations."))
to.remove <- match(input$Station.name, unique(input$Station.name)[is.na(link)])