In sccastro/DRTr: Reading, Analyzing, and Visualizing Detection Response Task Output Files

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

This vignette explains how to process your output files from a Detection Response Task. First, use one of the combine functions to combine your input files into one csv with information from the name of the files appended to the data frame as columns. For example, in this vignette we have eight .txt files with information in the names of the files separated by an underscore (_). Because our .Rmd file is in the same directory, we can use getwd() to specify our working directory as the fpath, or filepath. .Rmd and .R files are filtered out automatically, allowing just your .txt, .csv, or other separated value files to be combined.

library(DRTr)

combineCSV(fpath = getwd(), dataname = df)

head(df)

Now there should be an object under Data in your Global Environment with the dataname that you specified. However, that dataset is probably pretty messy. There are probably some columns that you don't need, and none of them have names. That's ok, you can use nameCheck to simultaneously get the columns you're most interested in with appropriate names.

newdf <- nameCheck(df, "V1",c("V3","V4"), "X1","X3","X4",mics = NULL,"X7","X19") #Have to fix having 1 or more condition columns

Then, visualize the data utilizing the viz functions.

vizBySubject(newdf,plottype = "bar",subid = "subid",cond = "cond", DV= "rt")

Finally, you can perform summaries or statistics on your dataset with some helpful compare functions.

1+1

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)

sccastro/DRTr documentation built on May 17, 2019, 1:15 a.m.