audioSplom {audiolyzR}R Documentation

audioSplom geneartes a scatterplot matrix-like series of tone matrices

Description

Translates a scatterplot matrix into an audioplot, with help from hexplom. The audiolyzR plots are played according to the selected plot in the drop-down menu. The result can be considered similar to "movements" of a piece of music, with each scatterplot representing a separate movement within the larger piece.

Usage

audioSplom(x = NULL, data, purge.plots = FALSE,
           bins = 30, aspect = 1, radius = floor (sqrt(bins)) - 1,
           key = "C", quality = "Major", tempo = 115,
           directory = file.path (Sys.getenv("R_LIBS_USER"), "audiolyzR"),
           output = file.path (tempdir(), "json_matrix"), write.to.home = NULL, ...)

Arguments

x

An optional character vector of names c("name1","name2",etc.)
-or-
An optional formula specifying variables to be included in the splom. All that is required is a data.frame object.

data

Required data frame object

purge.plots

Specifies whether to erase the directory containing the plots that the audiolyzR synthesizer accesses. Default is FALSE, so plots will pile up unless you change it to TRUE.

bins

Optional specification of bins for hex binning step. Default is 30.

aspect

Optional aspect ratio adjustment. Default is 1

radius

Used to obtain the number of nearest neighbors for each bin/point. Default is square root of number of bins.

key

Optional, not yet fully implemented. The desired key for the audio matrix. This can be adjusted manually in the audiolyzR synthesizer.

quality

Optional. Quality of the specified key. Default is "Major". This is not yet fully implemented, and can be changed manually in the audiolyzR synthesizer.

tempo

Optional. Tempo to set as default (You can also change tempo in the audiolyzR synthesizer). Default is 115 bpm.

directory

The path of the parent directory containing the audiolyzR synthesizer. This defaults to the "audiolyzR" folder in your "R_LIBS_USER" directory.

output

This is simply a temporary directory by default. If you wish to change it, the only sensible option is the HOME directory. Included for transparency.

write.to.home

The standalone synthesizer application will look in your HOME directory for plot files when it opens. R will request permission to write there during the current session. If you refuse, it will still work, but you will need to drag the appropriate folder to the synthesizer (a message will explain how). Adjusting this in the function call will have no effect.

...

Additional arguments to be fed to hexbin() and hexbinplot().

Value

Produces a hexplom of the specified or supported variables, and then plays the corresponding audio scatterplots, generated in the audiolyzR standalone.

External Application Instructions

The audiolyzR package requires a free standalone synthesizer application. the first time you run an audio*Plot* function, the program will download and install automatically. By default, the app installs into the file.path (Sys.getenv("R_LIBS_USER"), "audiolyzR") directory, which is where the package's functions will look for it. You are free to install it whereever you like, but you must specify its parent directory in your function calls.

If you prefer to install it yourself:

audiolyzR application for Mac:
http://s3.amazonaws.com/audiolyzR/installers/the_audiolyzR_mac_v5.zip

audiolyzR application for Windows:
http://s3.amazonaws.com/audiolyzR/installers/the_audiolyzR_win_v5.zip

Side Effects

Saves a file to the output directory in order to generate audio. Also, a plot will be produced in the graphics window.

Author(s)

Eric Stone, Jesse Garrison

References

audiolyzR: http://biostat.mc.vanderbilt.edu/wiki/pub/Main/UseR-2012/81-Stone.pdf
Max/MSP: http://cycling74.com/whatismax/

See Also

hexbin

Examples

##Simple audioSplom example
## Not run: 
data(NHANES)
audioSplom(data=NHANES)

## End(Not run)

[Package audiolyzR version 0.4-9 Index]