collaboration_report: Generate a Collaboration Report in HTML

View source: R/collaboration_report.R

collaboration_reportR Documentation

Generate a Collaboration Report in HTML

Description

The function generates an interactive HTML report using Standard Person Query data as an input. The report contains a series of summary analysis and visualisations relating to key collaboration metrics,including email and meeting hours.

Usage

collaboration_report(
  data,
  hrvar = "AUTO",
  mingroup = 5,
  path = "collaboration report",
  timestamp = TRUE
)

Arguments

data

A Standard Person Query dataset in the form of a data frame.

hrvar

String containing the name of the HR Variable by which to split metrics. Defaults to "Organization". To run the analysis on the total instead of splitting by an HR attribute, supply NULL (without quotes).

mingroup

Numeric value setting the privacy threshold / minimum group size. Defaults to 5.

path

Pass the file path and the desired file name, excluding the file extension. For example, "collaboration report".

timestamp

Logical vector specifying whether to include a timestamp in the file name. Defaults to TRUE.

Value

An HTML report with the same file name as specified in the arguments is generated in the working directory. No outputs are directly returned by the function.

See Also

Other Reports: IV_report(), capacity_report(), coaching_report(), connectivity_report(), generate_report(), meeting_tm_report(), read_preamble(), subject_validate_report(), validation_report(), workpatterns_report()


wpa documentation built on Aug. 21, 2023, 5:11 p.m.