add segment names to part 6 output and rename start/end to startrec and endrec #1278

Author: vincentvanhees

R/g.report.part6.R

@@ -77,6 +77,7 @@ g.report.part6 = function(metadatadir = c(), f0 = c(), f1 = c(),
     #-------------------------------------------------------------
     # store all summaries in csv files
     outputfinal_clean = tidyup_df(outputfinal)
+    outputfinal_clean = addSplitNames(outputfinal_clean) # If recording was split
     data.table::fwrite(outputfinal_clean, paste0(metadatadir, "/results/part6_summary.csv"),
                        row.names = FALSE, na = "", sep = params_output[["sep_reports"]],
                        dec = params_output[["dec_reports"]])

R/splitRecords.R

@@ -76,7 +76,7 @@ splitRecords = function(metadatadir, params_general = NULL) {
           if (splitTime_tmp[1] > timestamp_short[1]) {
             segment_starts = timestamp_short[1]
             segment_ends = splitTime_tmp[1]
-            segment_names = paste0("startTO", split_names[1])
+            segment_names = paste0("startrecTO", split_names[1])
           }
           for (segment_index in 1:length(splitTime_tmp)) {
             if (segment_index < length(splitTime_tmp)) {
@@ -88,7 +88,7 @@ splitRecords = function(metadatadir, params_general = NULL) {
               segment_starts = c(segment_starts, splitTime_tmp[segment_index])
               segment_ends = c(segment_ends, timestamp_short[length(timestamp_short)])
               segment_names = c(segment_names, paste0(split_names[segment_index],
-                                                      "TOend"))
+                                                      "TOendrec"))
             }
           }
           # Store each part separately
@@ -135,9 +135,9 @@ splitRecords = function(metadatadir, params_general = NULL) {
                 }
                 newFileName = paste0(newfilebase, id_separator, "split", g, "_", segment_names[g], ".", extension)
                 # add back to I$filename because part 2 uses this in the csv report
-                I$filename = gsub(pattern = "meta_", replacement = "", x = newFileName)
-                newFileName = paste0(dirname(S$filename[j]), "/", newFileName)
-                newRDataFileName = paste0(newFileName, ".RData")
+                filename_dir = gsub(pattern = "meta_", replacement = "", x = newFileName)
+                I$filename = filename_dir
+                newRDataFileName = paste0(dirname(S$filename[j]), "/", newFileName, ".RData")
                 file_was_split = TRUE
                 save(M, C, I,
                      filefoldername, filename_dir, tail_expansion_log,

man/GGIR.Rd

@@ -285,8 +285,11 @@ GGIR(mode = 1:5,
         format is specified with parameter \code{recording_split_timeformat}.
         The names of these columns are used to refer to each resulting segment.
         To prevent extremely long file name GGIR ignores spaces and does not consider
-        more than 10 characters which are forced to lower case. This functionality
-        is applied after all other aspect of GGIR part 1 are completed for all input files.
+        more than 10 characters which are forced to lower case. If the recording
+        starts before or ends after the first and last split time then the start and/or
+        end of the recording is also used as split time and referred to as
+        startrec and endrec, respectively. Files are split after all other aspect of
+        GGIR part 1 are completed for all input files.
       }
 
       \item{recording_split_timeformat}{

tests/testthat/test_splitRecords.R

@@ -46,18 +46,18 @@ test_that("Recording can be split", {
   # File created?
   expect_true(dir.exists("./testfolder/meta/basic"))
   expect_equal(length(dir("./testfolder/meta/basic")), 2)
-  expect_true(file.exists("./testfolder/meta/basic/meta_1_1-1-1900_split1_startTOtime1.bin.RData"))
-  expect_true(file.exists("./testfolder/meta/basic/meta_1_1-1-1900_split2_time1TOend.bin.RData"))
+  expect_true(file.exists("./testfolder/meta/basic/meta_1_1-1-1900_split1_startrecTOtime1.bin.RData"))
+  expect_true(file.exists("./testfolder/meta/basic/meta_1_1-1-1900_split2_time1TOendrec.bin.RData"))
 
   # File content correct?
-  load("./testfolder/meta/basic/meta_1_1-1-1900_split1_startTOtime1.bin.RData")
+  load("./testfolder/meta/basic/meta_1_1-1-1900_split1_startrecTOtime1.bin.RData")
   expect_equal(nrow(M$metashort), 8100)
   expect_equal(nrow(M$metalong), 45)
   expect_equal(M$metashort$timestamp[1], "2013-11-14T11:45:00+0000")
   expect_equal(tail(M$metashort$timestamp, n = 1), "2013-11-14T22:59:55+0000")
   expect_equal(M$metalong$timestamp[1],  "2013-11-14T11:45:00+0000")
   expect_equal(tail(M$metalong$timestamp, n = 1), "2013-11-14T22:45:00+0000")
-  load("./testfolder/meta/basic/meta_1_1-1-1900_split2_time1TOend.bin.RData")
+  load("./testfolder/meta/basic/meta_1_1-1-1900_split2_time1TOendrec.bin.RData")
   expect_equal(nrow(M$metashort), 10619)
   expect_equal(nrow(M$metalong), 58)
   expect_equal(M$metashort$timestamp[1], "2013-11-14T23:00:00+0000")