Add nearestPOI.R

davebraze · Jun 29, 2017 · 04a40c6 · 04a40c6
1 parent 6734d45
commit 04a40c6
Show file tree

Hide file tree

Showing 31 changed files with 127 additions and 44 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,8 +1,8 @@
 Package: FDBeye
 Type: Package
 Title: Functions to Ease Work with Eyetracker Data
-Version: 0.0.19
-Date: 2016-10-25
+Version: 0.0.20
+Date: 2017-06-28
 Authors@R: c(
     person("David", "Braze", email="[email protected]", role=c("aut", "cre")),
     person("Tao", "Gong", role="aut"),
@@ -20,6 +20,7 @@ Imports:
     grid,
     plyr,
     png,
+    purrr,
     stats,
     stringr,
     tools,
@@ -35,7 +36,7 @@ License: MIT + file LICENSE
 LazyData: true
 URL: https://github.com/davebraze/FDBeye
 BugReports: https://github.com/davebraze/FDBeye/issues
-RoxygenNote: 5.0.1
+RoxygenNote: 6.0.1
 Suggests:
     knitr,
     rmarkdown

diff --git a/NAMESPACE b/NAMESPACE
@@ -17,6 +17,7 @@ export(get_xybounds)
 export(inked)
 export(makeReport)
 export(mark_oob)
+export(nearestPOI)
 export(readELascii)
 export(reg2regdef)
 export(regdef2ias)

diff --git a/R/nearestPOI.R b/R/nearestPOI.R
@@ -0,0 +1,40 @@
+##' @title Find the nearest Point of Interest for each fixation.
+##'
+##' @description For each fixation in a fixation report, this function
+##'     will determine the nearest Point of Interest and the
+##'     fixation's distance from that Point of Interest.
+##'
+##' @details For each fixation in a fixation report, this function
+##'     will determine the nearest Point of Interest and the
+##'     fixation's distance from that Point of Interest.
+##'
+##'     The value of \code{supplement} determines whether to return
+##'     the POI values within an enriched version of \code{fixReport},
+##'     or as a simple two column data.frame.
+##'
+##' @param fixReport A fixation Report as may be created by
+##'     fixReport(). Must contain columns \code{xpos} and \code{ypos}.
+##' @param poiList A data.frame containing x,y coordinates for Points
+##'     of Interest. The data.frame must contain exactly two columns,
+##'     named \code{xpos} and \code{ypos}, in that order.
+##' @param supplement If TRUE, nearestPOI() will return a data.frame
+##'     consisting of fixReport suplemented with columns nearestpoi
+##'     and dist2poi. If FALSE return a 2 column data.frame with just
+##'     those two columns.
+##' @return A data.frame including columns nearestpoi and dist2poi.
+##' @author Dave Braze <davebraze@@gmail.com>
+##' @export
+nearestPOI <- function (fixReport, poiList, supplement=TRUE) {
+    f <- function(fix=fix, poiList=poiList) {
+        ## Find nearest poi for one fixation.
+        tmp <- rbind(fix[c("xpos", "ypos")], poi) ## should merge rather than rbind
+        dst <- as.matrix(dist(tmp))[-1,1]
+        .nearestpoi <- which.min(dst)
+        names(.nearestpoi) <- NULL
+        .dist2poi <- min(dst)
+        retval <- data.frame(nearestpoi=.nearestpoi, dist2poi=.dist2poi)
+    }
+    retval <- purrr::by_row(fixReport, f, poi=poi, .collate="row",
+                            .labels=supplement)
+    select(retval, -matches("^.row$"))
+}
diff --git a/man/EToralreading.Rd b/man/EToralreading.Rd
diff --git a/man/FDBeye.Rd b/man/FDBeye.Rd
diff --git a/man/adjust_y.Rd b/man/adjust_y.Rd
diff --git a/man/ascAnon.Rd b/man/ascAnon.Rd
diff --git a/man/cat_lines1.Rd b/man/cat_lines1.Rd
diff --git a/man/cat_lines2.Rd b/man/cat_lines2.Rd
diff --git a/man/cat_lines3.Rd b/man/cat_lines3.Rd
diff --git a/man/cat_lines4.Rd b/man/cat_lines4.Rd
diff --git a/man/edf2asc.Rd b/man/edf2asc.Rd
diff --git a/man/fixPlot.Rd b/man/fixPlot.Rd
diff --git a/man/fixReport.Rd b/man/fixReport.Rd
diff --git a/man/getBGcol.Rd b/man/getBGcol.Rd
diff --git a/man/getChars.Rd b/man/getChars.Rd
diff --git a/man/getEyelinkTrialData.Rd b/man/getEyelinkTrialData.Rd
diff --git a/man/getLines.Rd b/man/getLines.Rd
diff --git a/man/getMargins.Rd b/man/getMargins.Rd
diff --git a/man/get_start_pts.Rd b/man/get_start_pts.Rd
diff --git a/man/get_xybounds.Rd b/man/get_xybounds.Rd
diff --git a/man/inked.Rd b/man/inked.Rd
diff --git a/man/makeReport.Rd b/man/makeReport.Rd
diff --git a/man/mark_oob.Rd b/man/mark_oob.Rd
diff --git a/man/nearestPOI.Rd b/man/nearestPOI.Rd
diff --git a/man/readELascii.Rd b/man/readELascii.Rd
diff --git a/man/reg2regdef.Rd b/man/reg2regdef.Rd
diff --git a/man/regdef2ias.Rd b/man/regdef2ias.Rd
diff --git a/man/region2SRias.Rd b/man/region2SRias.Rd
diff --git a/man/saccReport.Rd b/man/saccReport.Rd
diff --git a/man/trial_plots.Rd b/man/trial_plots.Rd