In tz-lom/Resonance-Rproj: Interface for Resonance project

Stream types

There are many types of data, that can be processed with Resonance, some of them sutaible for input and output data streams, other - for internal processing, but there is no limitation of what streams you use for input and output, only limitations of pipes.

Current version of Resonance contatins following stream types: - channels - window - event

channels

Each data block of 'channels' type contains recording of one or more channels of data, collected isochroniously with fixed sampling rate. Attributes of such type are - channels - amount of channels in every block - samplingRate- sampling rate of stream

window

• channels
• size

event

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 setion 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)

tz-lom/Resonance-Rproj documentation built on July 1, 2019, 4:53 p.m.