popup: Create Mouseovers

In trinker/reports: An R Package to Assist in the Workflow of Writing Academic Articles and Other Reports

Description

Generate mousever events for text.

Usage

popup(presentation = FALSE, rmd.path = NULL)

Arguments

presentation	logical. If TRUE created popup.js documentation in the PRESENTATION directory. FALSE generates the documentation in the REPORT directory.
rmd.path	An optional path to a .Rmd file if presentation = FALSE.

Details

popup adds the css/js scripts necessary to create hight quality mouseover popup events. The user must become familiar with Nicolas Honing's popup.js. Currently no shortcut reports package tag generating function is offered for popups that utilize popup.js. To view example uses see https://github.com/trinker/popup_example.

Value

Generates an assets directory with appropriate javascript and css to make mousever popups.

Note

If adding popup.js documents to non-slidify, .Rmd based presentations the user may have to manually add:

<link rel="stylesheet" href="./assets/css/pop_style.css" />
<script type="text/javascript" src="./assets/js/jquery-1.9.1.min.js"></script>
<script type="text/javascript" src="./assets/js/nhpup_1.1.js"></script>

to the document.

References

https://github.com/nhoening/popup.js

Examples

## Not run: 
popup()

## End(Not run)

trinker/reports documentation built on May 31, 2019, 9:51 p.m.