In ty14/ezTrackR: Analyzing ezTrack Data

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

Raw Data

There are two example dataset files in the ezTrackR package. habit contains data from a habituation trial, and cup contains data from a social approach trial.

library(ezTrackR)
head(habit)

The column names of the habit dataset are:

colnames(habit)

Getting XY coordinate data.

Using the get_coords_habit() function extracts XY data. The default is to return 300 seconds worth. This will be from the beginning of the file, unless the burnin parameter is adjusted from 0. The function assumesa frame rate of 30fps.

habit.xy <- get_coords_habit(habit)
str(habit.xy)

The data are returned in a list. The first element $box gives the coordinates of the box. These are averages of the left, top, bottom and right coordinates. The second element xy gives the XY plot data. The first two columns are the raw tracked data. The plotX and plotY columns give the coordinates corrected for when tracking veers slightly outside of the box coordinates. The final two columns rescaleX and rescaleY give data points rescaled on an axis between 0 and 1000.

habit.xy$box

habit.xy$xy

Distance

Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The html_vignette output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible. The html_vignette format:

• Never uses retina figures
• Has a smaller default figure size
• Uses a custom CSS stylesheet instead of the default Twitter Bootstrap style

Vignette Info

Note the various macros within the vignette section of the metadata block above. These are required in order to instruct R how to build the vignette. Note that you should change the title field and the \VignetteIndexEntry to match the title of your vignette.

Styles

The html_vignette template includes a basic CSS theme. To override this theme you can specify your own CSS in the document metadata as follows:

output: 
  rmarkdown::html_vignette:
    css: mystyles.css

Figures

The figure sizes have been customised so that you can easily put two images side-by-side.

plot(1:10)
plot(10:1)

You can enable figure captions by fig_caption: yes in YAML:

output:
  rmarkdown::html_vignette:
    fig_caption: yes

Then you can use the chunk option fig.cap = "Your figure caption." in knitr.

More Examples

You can write math expressions, e.g. $Y = X\beta + \epsilon$, footnotes^[A footnote here.], and tables, e.g. using knitr::kable().

knitr::kable(head(mtcars, 10))

Also a quote using >:

"He who gives up [code] safety for [code] speed deserves neither." (via)

ty14/ezTrackR documentation built on Nov. 5, 2019, 11:02 a.m.