search

microsoft / vivainsights-py

Python package for Analyzing and Visualizing data from Viva Insights
https://microsoft.github.io/vivainsights-py/
Other
13 stars 2 forks source link

Feature request: diagnostic message when running `identify_holidayweeks()` #33

Open martinctc opened 3 months ago

martinctc commented 3 months ago

When running the following, it would be helpful to have a diagnostic message printed that informs which weeks were removed in the console: 

pq_data = vi.identify_holidayweeks(pq_data, sd = 1, return_type = 'data_cleaned')

e.g. 

"The weeks 2024-01-1, 2024-01-08 have been flagged as holiday weeks and removed from the data."
martinctc commented 3 months ago

A couple of additional comments:

Firstly, it may be helpful to reiterate the threshold used in filtering out the holiday weeks, so for instance: 

"The weeks 2024-01-1, 2024-01-08 have been flagged as holiday weeks and removed from the data. 
This is based on a standard deviation of 1 below the mean collaboration hours."

Secondly, the same output should also apply to identify_inactiveweeks() and identify_nkw() when returning a "clean data" output.

Thirdly, we should also print the output first and return the data frame, so the final object returned is the data frame and not the text string.