IntiQuan IQReport Repository

Quick Installation on Windows - directly from R

The easiest way to install IQReport on Windows is to call the following functions directly from R: The above commands do install IQReport and the IQReportAPI R package that allows to interface to IQReport from R. If this does not work for you, or you want to install it on a non-Windows computer, then you will find below the standard installation procedure.

By downloading and installing IQReport you agree to have read and understood the licensing agreement.

Linux and other Information

IQReport is available for Windows and Linux. More information about installation, documentation, support, etc. can be found after the Quick Intro.

Quick Intro

Below you can see a side-by-side comparison of IQReport and Word. The default Word template is used but IQReport allows to handle any desired Word style.

This simple example covers the basic functionality. The documentation (see below) covers all features. Or ask us for a quick intro.

 

====

TITLE:     A Very Short Introduction to IQReport

SUBTITLE:  Extended Markdown Syntax

DATE:     24 December 2018

TEMPLATE: DefaultStyle.rmdt

=====

 

% Comments in the markdown document begin with "%"

% They won't be visible in the Word report.

 

% Start with a new page

 

!NEWPAGE

 

 

% Sections with numbers

 

# Numbered Section

 

## Numbered Subsection

 

### Numbered Subsubsection

 

 

% Sections without numbers

 

#* Unumbered Section

 

##* Unnumbered Subsection

 

###* Unnumbered Subsubsection

 

 

% The next section has a label to be referenced later in the text

 

# Using Markdown Syntax {#firstref}

 

 

% Normal markdown to format text

This text is **bold** and this text is *italic*.

 

 

% Lists

Here begins an enumerated list

 

1. First item

    1. First sub-item (requires four blanks)

    2. Second sub-item

2. Second item

 

This is the same example without numbers

 

* First item

    * First sub-item

    * Second sub-item

* Second item

 

 

Inline tables can be defined like that:

 

!TABINLINE[This is my inline table, label:inlineTable, style:TAB(9)]

| Tables        | Are           | Cool  |

| ------------- |:-------------:| -----:|

| col 3 is      | right-aligned | $1600 |

| col 2 is      | centered      |   $12 |

| zebra stripes | are neat      |    $1 |

 

# External Tables and Figures

 

Tables in a markdown format can be saved in separate files and included in the text. IQReport comes with an R package that provides the functionality to directly export markdown tables from your data frames.

 

!TAB[This is a nice parameter estimation table, label:parameters](Tables/project_parameters_table.txt)

 

The same holds for figures. Valid formats are pdf, jpg and png.

 

!FIG[This is a nice plot, label:vpc, scale:70](Figures/VPC.png)

 

# Cross-References

 

Elements with labels can be cross-reference, see @SEC(firstref), @TAB(inlineTable), @TAB(parameters) or @FIG(vpc).

 

# Equations

 

Mathematical equations can be define inline, as here $A = \pi r^2$, or in display mode:

 

$$\frac{dx}{dt} = A(\theta)x + b(\theta)$$

 

# Further Reading

 

* For basic markdown see @URL(https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)

* For more details to all the options that come with the extended markdown syntax see @URL(https://iqreport.intiquan.com/doc/IQReport_Documentation.pdf)

 

 

Download IQReport

Windows Version

Linux Version

  • Download IQReport software (IQReport.tar.gz)

    Installation of IQReport

    Windows Version

    Linux Version

    IQReport R API

    IQReport comes with an R API that allows to easily generate output files for IQReport tables directly from R data.frames. This API is installed easiest in the following way from R:

    Alternatively, you can execute the following command in R:

    Documentation of IQReport

    A detailed documentation of IQReport is available here: IQReport_Documentation.pdf.

    Support of IQReport

    A support forum is available at: https://support.intiquan.com.

    Release Notes

    Release notes for different IQReport versions can be found here: RELEASE_NOTES.txt

    Customized IQReport Versions

    IQReport can be customized to generate Word documents in the exact Word style required by a corporation. In the default download only a default Word style is available. If you are interested to have a customized version, tailored to your corporate style, contact us (info@intiquan.com) for a quote. In addition to custom Word templates also the NotePad++ syntax highlighting and contained text macros can be customized.