reports

reports is a package that assists in writing reports and presentations by providing a frame work that brings together existing R, LaTeX/.docx and Pandoc tools. The package is designed to be used with RStudio, MikTex/Tex Live/LibreOffice, knitr, slidify, knitcitations, Pandoc and pander. The user will want to download these free programs to maximize the effectiveness of the reports package.

Development Version Installation

Download the development version of reports here

Help topics

Template

Functions to generate report/presentation templates.

• new_report
  Report Template
• new_vignette append_vignette
  Vignette Template
• presentation
  Presentation Template
• qrepo
  Quick Repository Template
• templates slidify_templates
  View Templates

Text Formatting

Functions to format text.

• CA
  Capitalize Every Word of String
• CW
  Count Words
• GQ
  Format Quotes
• QQ
  Format Quotes
• LL
  Format Text Lines to LaTeX List
• QC
  Quick Convert: Pandoc Convert a String

Path (Text String) Formatting

Functions to format character strings related to paths/urls.

• pad
  Pad Strings
• QP
  Quick Path
• UF PF
  Path/URL: Fill Blank Spaces
• US
  Path/URL: Fill Blank Spaces
• WP
  Convert Windows Path

Insert HTML Objects

Functions to format text.

• AD
  Audio url/path to HTML Audio Tag
• CM
  HTML Comment Character
• CN
  Wrap Text With HTML Courier New Font Tag
• EM
  Convert email to HTML email Tag
• FT
  Wrap Text With HTML Font Tag
• HR HR2 BT
  Convert path/url to HTML href Tag
• HL
  Highlight HTML Text
• HS VS
  Insert HTML Space
• IF
  url to HTML iframe Tag
• IM IM2 IW IMF IM_MO
  Convert path/url to HTML Image Tag
• PN
  Insert Presenter Notes
• RF
  Slidify Shortcut to Include reveal.js Animated Fragments
• SC
  HTML Special Characters
• TB TB2
  Wrap text in text boxes.
• YT VM VD
  Video (YouTube/Vimeo/local) url to HTML iframe/video Tag
• col2hex
  Convert R colors to Hexadecimal

Citations

Function to assist in citing text.

• BV
  View Bibliography
• citeL
  Format Quotes with Citations
• parenciteL
  Format Quotes with Citations
• parenciteM
  Format Quotes with Citations
• posciteL
  Format Quotes with Citations
• possciteL
  Format Quotes with Citations
• textciteL
  Format Quotes with Citations
• textciteM
  Format Quotes with Citations
• notes
  View Notes
• update_bib
  Update bib File
• web read.web write.web
  Functions for Internet Articles/Information

Directory Management

Functions to aid in managing directories/folders.

• delete
  Easy File Handling
• folder
  Easy File Handling
• local_host run_lh
  Generate Local Host Bash/Batch
• repo2github
  Upload a Local Repo to GitHub
• rdirs
  Recursive Directory Creation
• sync sync_img sync_rnp sync_all
  File Syncing

Document Conversion

Functions to convert documents.

• tex2docx
  Convert tex/markdown/html to docx/tex/html
• html2pdf
  Convert tex/markdown/html to docx/tex/html
• md2docx
  Convert tex/markdown/html to docx/tex/html
• md2html
  Convert tex/markdown/html to docx/tex/html
• md2pdf
  Convert tex/markdown/html to docx/tex/html
• md2tex
  Convert tex/markdown/html to docx/tex/html
• tex2html
  Convert tex/markdown/html to docx/tex/html

User Defined Templates

Function to create user defined template.

• doc_temp
  Document Template

reports Tools

Exported tools used within reports.

• IE
  Flexible ifelse Like Functionality for Arguments
• is.global
  Test If Environment is Global
• is.url
  Check If String is a URL

Customization

Tools for customized css and layouts.

• custom_css css_styles css_style_change css_style_add
  Generate Custom css for RStudio + knitr
• js_copy
  Utility Fuction to Copy reports Package JavaScript
• popup
  Create Mouseovers
• slidify_layouts
  Generate Extra Slidify Layouts

Decapricated

Functions that will be removed from the reports package in version 2.0.0.

• html5
  Convert md to HTML5 Slides
• reveal.js
  Convert md to HTML5 reveal.js