/doktor

Rmarkdown template collection for dxFeed

Primary LanguageTeXMIT LicenseMIT

doktor: Rmarkdown template collection for dxFeed

Here's a pill for your latex-ache. Allows to build reports with consistent style, with appropriate branding, typography and bibliography. Integrates with RStudio. Just what the doktor prescribed.

Installation

Prerequisites

  • You obviously need R. RStudio is optional, but recommended.
  • You also need a latex installation, like TeX Live or MiKTeX,
  • as well as rmarkdown package.
  • Make sure SciPy is installed (python3-scipy in dpkg-based distros).
  • The example report uses Merriweather and Ubuntu fonts; see below for installation instructions.

Fonts installation

Merriweather and Merriweather Sans can be either downloaded directly from Google, or installed as a part of the texlive-fonts-extra package. Note that the fonts included in the package may be outdated compared with their upstream versions. If downloading from Google:

  1. Unzip the archives somewhere (say, into /usr/local/share/fonts); make sure the directory is accessible to fontconfig, if not create a corresponding config file, like /etc/fonts/conf.d/08-local-share.conf

    <?xml version="1.0"?>
    <!DOCTYPE fontconfig SYSTEM "fonts.dtd">
    <fontconfig>
      <dir>/usr/local/share/fonts</dir>
    </fontconfig>
    
  2. Rebuild the font cache with fc-cache -fsv.

The Ubuntu fonts are bundled with the fonts-ubuntu package.

Option A: via devtools

If package devtools is installed:

devtools::install_github("tonytonov/doktor")

Option B: checkout and build

Alternatively, check out the repository and install manually.

Usage

Create new document from RStudio via "File" -- "New File" -- "R Markdown..." -- "From Template". Knit the default document to see if everything works fine.

Examples are in inst/:

LyX Templates

There are two additional LyX templates in inst/lyx/templates/:

  • dxfeed-doktor.lyx which mimics the look of doktor-generated documents --- handy if you need to typeset complicated mathematics. You won't be able to run R code chunks and get the output right in the document, though.
  • dxfeed-slides.lyx for producing dxFeed-branded beamer presentation slides.

Feel free to open issues and suggest new templates or tweak existing.