Skip to content
Snippets Groups Projects
idashboard-class.Rd 918 B
Newer Older
  • Learn to ignore specific revisions
  • jens.preussner's avatar
    jens.preussner committed
    % Generated by roxygen2: do not edit by hand
    
    % Please edit documentation in R/i2dashboard.R
    \docType{class}
    \name{idashboard-class}
    
    jens.preussner's avatar
    jens.preussner committed
    \alias{idashboard-class}
    
    \alias{i2dashboard}
    \title{The idashboard S4 class.}
    
    jens.preussner's avatar
    jens.preussner committed
    \usage{
    
    \S4method{initialize}{i2dashboard}(.Object, ...)
    
    \S4method{show}{i2dashboard}(object)
    
    jens.preussner's avatar
    jens.preussner committed
    
    
    i2dashboard(...)
    
    jens.preussner's avatar
    jens.preussner committed
    }
    \description{
    
    The idashboard S4 class.
    
    jens.preussner's avatar
    jens.preussner committed
    
    
    Constructor method of the i2dashboard class.
    
    jens.preussner's avatar
    jens.preussner committed
    
    
    Show method of the i2dashboard class.
    
    Create a new i2dashboard object.
    
    jens.preussner's avatar
    jens.preussner committed
    }
    \section{Slots}{
    
    \describe{
    \item{\code{title}}{The dashboards title}
    
    
    Ustjanzew's avatar
    Ustjanzew committed
    \item{\code{author}}{The author of the dashboard}
    
    \item{\code{interactive}}{If a shiny-based report should be created}
    
    \item{\code{theme}}{The theme of the dashboard}
    
    
    \item{\code{datadir}}{Path to the directory, where report data is stored.}
    
    \item{\code{file}}{Filename of the resulting report Rmd file.}
    
    
    jens.preussner's avatar
    jens.preussner committed
    \item{\code{pages}}{A list of dashboard pages}
    }}