write_report: Create a HTML report for (RLum) objects

In coffeemuggler/eseis: Environmental Seismology Toolbox

Create a HTML report for (RLum) objects

Description

This function creates a HTML report for a given eseis object, listing its complete processing history. The report serves both as a convenient way of browsing through objects and as a proper approach to documenting and saving scientific data and workflows.

Usage

write_report(object, file, title = "eseis report", browser = FALSE, css)

Arguments

object	eseis object to be reported on
file	Character value, name of the output file (without extension)
title	Character value, title of the report
browser	Logical value, optionally open the HTML file in the default web browser after it has been rendered.
css	Character value, path to a CSS file to change the default styling of the HTML document.

Details

The function heavily lends ideas from the function report_RLum() written by Christoph Burow, which is contained in the package Luminescence. This function here is a truncated, tailored version with minimised availabilities.

Value

HTML and .Rds file.

Author(s)

Michael Dietze

Examples

## Not run: 
## load example data set
data(rockfall)

## make report for rockfall object
write_report(object = rockfall_eseis, 
             browser = TRUE)

## End(Not run)

coffeemuggler/eseis documentation built on Nov. 25, 2024, 8:31 p.m.