BasicHTML {HTMLUtils}R Documentation

creates a basic HTML page displaying plots and annotations

Description

Creates a basic HTML page displaying plots and annotations that can easily be navigated. The plots can be created either 'on the fly' by passing the appropriate commands or beforehand in which case just the filenames need to be passed.

Usage

BasicHTML(cmds = NULL, HTMLobjects, Captions, MenuLabels, Comments,
         file = "tmp.html", title = "", width = 480, height = 480, 
         FRAMES = FALSE, JSCPATH = "jsc", LaunchPage = FALSE, APPEND = FALSE, verbose = 0)

Arguments

cmds list of commands that generates the plots. If missing, the graphfiles are assumed to exist already.
HTMLobjects list of graph filenames, either to be created by the list of commands or to be copied to the Figures subdirectory and/or dataframes to be displayed in sortable tables.
Captions vector of captions; these go directly below the graphs
MenuLabels vector of labels for the main page.
Comments Text/comments to be written between the graphs
file file name of main page; '.html' extension will be added. The '_main' and '_menu' pages use this base as well.
title title to be written in the navigation/menu page
width width for all graphfiles
height height for all graphfiles
FRAMES is this an HTML page with frames ?
JSCPATH path that should contain the jsc components. If non existing, user will be prompted for installation.
LaunchPage launch the page ?
APPEND append to existing HTML page ?
verbose level of verbosity

Author(s)

Markus Loecher, Sense Networks <markus@sensenetworks.com>

See Also

FramedHTML

Examples

        #example with plots and graphfiles being generated on the fly:
        ## Not run: 
        BasicHTML(cmds = list("plot(rnorm(100));","plot(1:10);"), HTMLobjects = list("Fig1.png", "Fig2.png"), Captions=c("Gaussian noise","seq 1:10"),  MenuLabels = c("Marvel at the graph below","scatterplots are nice"), title="Test Page",width=480, height=480, verbose=1, JSCPATH = NULL)
        
        #example with plots and graphfiles having been generated beforehand:
        png("Fig1.png");
        plot(rnorm(100));
        dev.off()
        png("Fig2.png");
        plot(1:10);
        dev.off();
        
        BasicHTML( HTMLobjects = list("Fig1.png", "Fig2.png"), Captions=c("Gaussian noise","seq 1:10"), 
        MenuLabels = c("Marvel at the graph below","scatterplots are nice"), title="Test Page",
        width=480, height=480, verbose=1, JSCPATH = NULL);
        
        #example with absolute paths for graphfiles :
        Fig1 <- paste(tempdir(),"/Fig1.png",sep="")
        png(Fig1);
        plot(rnorm(100));
        dev.off()
        Fig2 <- paste(tempdir(),"/Fig2.png",sep="")
        png(Fig2);
        plot(1:10);
        dev.off();
        
        BasicHTML( HTMLobjects = list(Fig1, Fig2), Captions=c("Gaussian noise","seq 1:10"),  
        MenuLabels = c("Marvel at the graph below","scatterplots are nice"), title="Test Page",
        width=480, height=480, verbose=1, JSCPATH = NULL);
        #cleanup:
        #system(paste("rm ", Fig1));system(paste("rm ", Fig2))
## End(Not run)
 #example with sorted table:
 ## Not run: x <- cbind.data.frame(x1 = round(rnorm(10),3), x2 = round(runif(10),3));
 ## Not run: attr(x, "HEADER") <- "some random numbers";
 ## Not run: 
BasicHTML(HTMLobjects = list("Fig1.png", x, "Fig2.png"), 
        Captions=c("Gaussian noise","Gaussian and uniform random numbers", "seq 1:10"), 
        file = paste(Sys.getenv("HOME"), "/public_html/tmp/tmp.html",sep=""), JSCPATH = "../jsc");
## End(Not run)

[Package HTMLUtils version 0.1.3 Index]