S2HTML
  Redirecting S+ output to HTML

[ Readme |  Why use it?  |  Functions  |  Demo |  The author  |  Download]


HTML EXPORT - FREE LIBRARY
*** The code in this library section is not supported by MathSoft. ***

A version for R is jointly in development. Fore more details, refer to the R/S2HTML page.

IMPORTANT

I develop this library for my own personal needs and found it very usefull.
Actually, development isn't still finished and I will try to add features. Feel free to use, copy, distribute this library.The only thing I ask is to include all files and to send me all improvement you could have done.
I would also appreciate you send me an e-mail telling me who you are and how you use functions.


This library section contains software for redirecting SPlus output to HTML files.


Note : it is not necessary to know HTML to use all functions, but it is recommanded to have some basic knowledge.


At this time, you have version 0.9 of the library. Furthers functions will be added. At this time, I use it with creating automatically indexes. I will add this feature (with HTML links).

Fee free to ask me any question and to propose me improvement.


 
Why should I use it?

  • HTML EXPORT allow you to use all HTML enhancement : colors, alignment, fonts...
  • You could also include graphics so that HTML reports could be done.
  • HTML page could be copied and pasted directly in Word!
  • Using fonts, you could do reports with greek letters (font Symbol)
     
     
    List of functions of S2HTML library

    NameClassDescription
    HTML.File NULL (String) Controls the name of the HTML file output will be redirected to. (eg 'c:\\splus.html'). A default name is given by calling HTMLSink().
    HTMLSink function Begins to redirect all output from SPlus simultaneously to an HTML page. This also includes an index of calls with links.
    IMPORTANT BUG HTMLSink temporarily alters .Program. HTMLSink(F) replaces correct default .Program but left SPlus not working anyway, and you can't quit SPlus without serious bugs...
    HTMLInitFile function Writes to an HTML page all beginning headers. This allows you to control backcolor or background.
    HTMLEndFile function Writes HTML code for end of HTML file (absolutly not necessary)
    title class Class title is used to export titles with HTMLExport. Titles must be string.
    as.title function Give class title to an object. Object must be string.
    HTMLExport function Generic function to export objects. See below implemented classes
    HTMLExport.array function -
    HTMLExport.atomic function -
    HTMLExport.data.frame function Exports dataframe with options for colors, alignments, size etc.
    HTMLExport.lm function Calls HTMLExport.summary.lm and add graphs (similat than asking a regression in SPlus menu).
    HTMLExport.matrix function -
    HTMLExport.summary.lm function redirects all classics output of a regression
    HTMLExport.title function With objects of class title, writes titles with control of colors, font, sizes etc.
    HTMLColumns function Allows to use columns (tables) and to put severall results side by side.
    HTMLInsertGraph function Automatically performs the exportation of a graph in JPEG or GIF and insert a link in HTML page.
    HTMLReplaceNA function Used by HTMLExport.data.frame to replace NA by '-'.
    HTML.LI function Inserts a LI tag (bullet for lists)
    HTML.BR function Insert a return carriage (BR tag)
    HTML.HR function Insert an horizontal break line (HR tag)
    HTMLPlot function Generic function to export severall plots. See implemented methods.
    HTMLPlot.lm function Uses HTMLInsertGraph to automtically output all regression's classic graphs (residuals, qqnorm, Cook's distances etc.)

    Demo

    New : Method for class lm.Look at the awesome result : REGRESSION
    This page is entirely generated only by the instruction:

    >HTMLExport(myreg.lm)

    Help files are not still done. See HTMLDemo to see how you can use it.


    >HTMLDemo("c:\\TEMP")

    In HTML subdirectory, you will find an output created by HTMLDemo.

    You can see the result here.


    Also look at HTMLlsfit which was a try.

    Basically, just init a file with HTMLInitFile

    > HTMLFile <- TMLInitFile("c:\\TEMP\\MyHTMLOutput.html")

    and use it to write

    > HTMLExport(object, File = HTMLFile)

    or

    > HTMLColumns(NCols, list(objects), File = HTMLFile)
    > HTMLExport(as.title("Here is a title"), File = HTMLFile)

    All options (and there are a lot of for data.frame) could easily beunderstood, at least I hope...


     
    About the author

    I am called Eric Lecoutre and have a graduate in apllied mathematics.I am actually a student at the university of Louvain-La-Neuve (Belgium)where I learn more and more about statistics.
    I don't speak very wellEnglish, so... I am a mid-time position in research and work on watermonitoring.
    I use HTML exportation for that work, save graphics in EPSformat in S+ code and have a Word macro to automatically insert graphsin my Word document. If interested with professional reports, it is agood solution.

    You could find more informations about me in my web page (in french)

  • http://www.stat.ucl.ac.be/ISpersonnel/lecoutre/

    and you can e-mail me:

  • lecoutre@stat.ucl.ac.be
     

    Download library

  • Download S2HTML.exe, self-extract archive.


    New versions of library will be available on my web page soon.

    Jan. 99 / Eric Lecoutre.