htmlSummary: Create HTML Report

In BiologicalRecordsCentre/sparta: Trend Analysis for Unstructured Data

Create HTML Report

Description

Create HTML Report for an occDet object.

Usage

htmlSummary(occDet, open = TRUE, output_dir = getwd(), output_file = NULL, ...)

Arguments

occDet	An object of class occDet
open	Logical, if TRUE the html report is opened once complete
output_dir	Character, the directory where the html file will be saved, defaults to the working directory.
output_file	(Optional) The file name given to the html file
...	Additional arguments passed to rmarkdown::render

Value

Path to html report

Examples

## Not run: 
# Create data
set.seed(125)
n <- 15000 #size of dataset
nyr <- 20 # number of years in data
nSamples <- 100 # set number of dates
nSites <- 50 # set number of sites

# Create somes dates
first <- as.Date(strptime("1980/01/01", "%Y/%m/%d")) 
last <- as.Date(strptime(paste(1980+(nyr-1),"/12/31", sep=''), "%Y/%m/%d")) 
dt <- last-first 
rDates <- first + (runif(nSamples)*dt)

# taxa are set as random letters
taxa <- sample(letters, size = n, TRUE)

# three sites are visited randomly
site <- sample(paste('A', 1:nSites, sep=''), size = n, TRUE)

# the date of visit is selected at random from those created earlier
survey <- sample(rDates, size = n, TRUE)

# run the model with these data for one species
# using defaults
results <- occDetModel(taxa = taxa,
                       site = site,
                       survey = survey,
                       species_list = 'a',
                       write_results = TRUE,
                       n_iterations = 1000,
                       burnin = 10,
                       thinning = 2)

generate summary
htmlSummary(results$a)


## End(Not run)

BiologicalRecordsCentre/sparta documentation built on June 12, 2024, 4:11 a.m.