diff --git a/docs/404.html b/docs/404.html index 3519fda..fceb152 100644 --- a/docs/404.html +++ b/docs/404.html @@ -30,7 +30,7 @@ eyetools - 0.7.3.9000 + 0.8.0 + + + + + +
+
+
+ +
+

Create a blank data frame for populating with AOIs

+
+ +
+

Usage

+
create_AOI_df(num_AOIs)
+
+ +
+

Arguments

+
num_AOIs
+

number of AOIs, setting the number of rows

+ +
+
+

Value

+ + +

a dataframe in the standard format required for eyetools

+
+ +
+

Examples

+
# create a data frame with 4 AOIs
+create_AOI_df(4)
+#>    x  y width_radius height
+#> 1 NA NA           NA     NA
+#> 2 NA NA           NA     NA
+#> 3 NA NA           NA     NA
+#> 4 NA NA           NA     NA
+
+
+
+
+ + +
+ + + + + + + diff --git a/docs/reference/dist_to_visual_angle.html b/docs/reference/dist_to_visual_angle.html index a16ffcb..edfe8fe 100644 --- a/docs/reference/dist_to_visual_angle.html +++ b/docs/reference/dist_to_visual_angle.html @@ -10,7 +10,7 @@ eyetools - 0.7.3.9000 + 0.8.0 + + + + + +
+
+
+ +
+

A tool for visualising a heatmap of raw data.

+
+ +
+

Usage

+
plot_heatmap(
+  data = NULL,
+  trial_number = NULL,
+  bg_image = NULL,
+  res = c(0, 1920, 0, 1080),
+  flip_y = FALSE,
+  alpha_control = 0.1,
+  plot_header = FALSE
+)
+
+ +
+

Arguments

+
data
+

data in standard raw data form (time, x, y, trial)

+ + +
trial_number
+

can be used to select particular trials within the data

+ + +
bg_image
+

The filepath of an image to be added to the plot, for example to show a screenshot of the task.

+ + +
res
+

resolution of the display to be shown, as a vector (xmin, xmax, ymin, ymax)

+ + +
flip_y
+

reverse the y axis coordinates (useful if origin is top of the screen)

+ + +
alpha_control
+

a single value to determine how much of the heatmap to obscure. Between 0 and 1. Lower values include more data in the heatmap

+ + +
plot_header
+

display the header title text which explains graphical features of the plot.

+ +
+
+

Value

+ + +

a plot of the raw data

+
+ +
+

Examples

+
# \donttest{
+data <- combine_eyes(HCL)
+data <- data[data$pNum == 118,]
+# plot all trials data
+plot_heatmap(data, alpha_control = .01)
+#> Warning: Removed 320 rows containing non-finite outside the scale range
+#> (`stat_density2d()`).
+#> Warning: Removed 396 rows containing missing values or values outside the scale range
+#> (`geom_tile()`).
+
+
+#plot one trial
+plot_heatmap(data, trial_number = 1)
+#> Warning: Removed 121 rows containing non-finite outside the scale range
+#> (`stat_density2d()`).
+#> Warning: Removed 396 rows containing missing values or values outside the scale range
+#> (`geom_tile()`).
+
+
+# }
+
+
+
+ + +
+ + + +
+ + + + + + + diff --git a/docs/reference/plot_seq-1.png b/docs/reference/plot_seq-1.png index 12318c1..f97882d 100644 Binary files a/docs/reference/plot_seq-1.png and b/docs/reference/plot_seq-1.png differ diff --git a/docs/reference/plot_seq-2.png b/docs/reference/plot_seq-2.png index 43bfae7..d5fdf6f 100644 Binary files a/docs/reference/plot_seq-2.png and b/docs/reference/plot_seq-2.png differ diff --git a/docs/reference/plot_seq-3.png b/docs/reference/plot_seq-3.png index 7bd026e..8d15146 100644 Binary files a/docs/reference/plot_seq-3.png and b/docs/reference/plot_seq-3.png differ diff --git a/docs/reference/plot_seq.html b/docs/reference/plot_seq.html index 4c1840f..d3976e4 100644 --- a/docs/reference/plot_seq.html +++ b/docs/reference/plot_seq.html @@ -14,7 +14,7 @@ eyetools - 0.7.3.9000 + 0.8.0