827b429a6e | ||
---|---|---|
.. | ||
README.md | ||
components.md | ||
create_expi.R | ||
exp report demo.html | ||
exp_preamble.md | ||
exp_report.Rmd | ||
jumbotron.html | ||
vis_exp.R |
README.md
Employee Experience RMarkdown Report Template
Parameters
The following parameters describe the arguments that will be passed to within the report function.
data
: the input must be a data frame with the columns as a Standard Person Query, which is built using thesq_data
inbuilt into the 'wpa' package.hrvar
: string specifying the HR attribute that will be passed into the single plot.mingroup
: numeric value specifying the minimum group size to filter the data by.
Report Type
This is a flexdashboard RMarkdown report.
The standard YAML header would be as follows:
output:
flexdashboard::flex_dashboard:
orientation: rows
vertical_layout: fill
Query Spec
Specifications
Run a single daily person query:
- Group by
Day
- At least 3 months
- Ensure that
IsActive
flag is not applied
All metrics
Note: Custom metrics shown in bolded italics
- Meeting hours 1 on 1 [SEE SPEC BELOW]
- Meeting hours 1 on 1 with same level [SEE SPEC BELOW]
- Time in self organized meetings
- Open 2 hour blocks
- Collaboration hours external
- Meetings with skip level
- Meeting hours with skip level
- Meeting hours 3 to 8 [SEE SPEC BELOW]
- Internal network size
- Meeting hours with manager
- Meeting hours
- Meetings
- Meetings with manager
- Meeting hours with manager 1 on 1
- Instant messages sent
- Emails sent
- Workweek span
- Collaboration hours
- Meeting hours with skip level max 8 [SEE SPEC BELOW]
- Meeting hours with manager with 3 to 8 [SEE SPEC BELOW]
Custom metrics
- Meeting Hours 1 on 1: where
Total attendees == 2
- Meeting Hours 1 on 1 with same level:
All attendee's and/or recipient's
whereLevelDesignation == @RelativeToPerson
ANDTotal attendees == 2
- Meeting hours 3 to 8:
Total attendees >= 3
ANDTotal attendees <= 8
- Meeting hours with skip level max 8:
Total attendees <= 8
, usingMeeting hours with skip level
. - Meeting hours with manager 3 to 8:
Total attendees >= 3
ANDTotal attendees <= 8
, usingMeeting hours with manager
. This is used to calculate small group meetings without manager by deducting this fromMeeting hours for 3 to 8 attendees
.
Report output
This report contains one single plot and a print out of the data diagnostics.
Data preparation
No data preparation is required as long as it is a Standard Person Query.
Examples
For an example of the report output, see minimal report.html
.
To run this report, you may run:
generate_report2(
output_format = rmarkdown::html_document(toc = TRUE, toc_depth = 6, theme = "cosmo"),
output_file = "minimal report.html",
output_dir = here("minimal-example"), # path for output
report_title = "Minimal Report",
rmd_dir = here("minimal-example", "minimal.Rmd"), # path to RMarkdown file,
# Custom arguments to pass to `minimal-example/minimal.Rmd`
data = sq_data,
hrvar = "Organization",
mingroup = 5
)