lzim / teampsd

Team PSD is using GitHub, R and RMarkdown as part of our free and open science workflow.
GNU General Public License v3.0
9 stars 23 forks source link

wk1-3_apr_epic_story_7: Code tt Report Automation #1748

Closed jamesmrollins closed 3 years ago

jamesmrollins commented 3 years ago

Objectives:

jamesmrollins commented 3 years ago

@lzim @staceypark @lijenn we are targeting having this to test by 19 April. I have set up #1753 QA Test card for @staceypark to help with testing. I will develop testing instructions on that card the week of 12 April.

jamesmrollins commented 3 years ago

As per conversation with @lijenn 4/21:

FYI: @staceypark @branscombj @MattMoore2 @lzim

Issue

Jane and Matt would like to ask team members at their meeting on 4/27, 7-8 AM PST, to complete the mtl.how/menu before S04 prep to enable Jane and Matt to review mtl.menu results at their prep meeting on 5/4. Since the Sim UI version of the mtl.how/menu will not be available until May 3, teams may not be able to use the Sim UI version in time to support Jane and Matt's preparation needs.

Facts Bearing on the Issue

Decisions

jamesmrollins commented 3 years ago

ADDENDUM

FYI: @staceypark @branscombj @MattMoore2 @lzim

Additional Facts That Have Come to Light

  1. REDCap surveys are truly anonymous. Since the Sim UI tracks the individual username and associates individual results to the others in the report, we need to know how people responded. Therefore, we cannot enter in user data from REDCap into the Sim UI since we do not have their identity.
  2. The Sim UI based mtl.how/menu can be ready-to-go by Monday morning.
  3. The Sim UI based mtl.how/menu is dependent on the Team Setup feature of the new Admin Dashboard. This also can be ready-to-go by Monday morning.
  4. The blue and red document analysis documented in issue #1907 shows only a few references to mtl.how/menu and the tt report via GIF screen casts. In all cases, we would need the Sim UI version of mtl.how/menu associated with the "mtl.how/menu" redirect before capturing an updated GIF, because the GIF shows the user entering "mtl.how/menu" into the URL line.
  5. Associated tt reports in the _resources folders associated with affected red and blue documents will need to wait for the completion of issue #1900 Re-create experiments in Sim UI.

Recommendations/Decisions

  1. Move Sim UI version of mtl.how/menu and Admin dashboard to PROD by Monday Morning (likely there by Friday, 4/23 morning).
  2. Use the upcoming team as the test case for using Admin dashboard to set up users.
  3. Change mtl.how/menu redirect to Sim UI version.
  4. Capture updated GIFs. Open pull requests for relevant lzim/mtl_blue documents and update GIFs. Complete by Monday, 4/26.
staceypark commented 3 years ago

@jamesmrollins prototype is looking great for the most part!

  1. I'm having issues getting the PDF to come up. I even tried refreshing and pages 2 & 3 are not loading. I am accessing this as "Ralph Malph" outside of the VA. image

  2. Font type & size

    • the logo should always be Myriad Pro since it's an image file
    • all the text should be Myriad Pro, and if the system cannot load that, it should default to a sans serif font like Calibri or Arial instead.
    • I would make the headings bigger across the graph sections; also make the titles for each of the graphs bigger and black instead of grey. image
  3. I think there needs to be more white space in the graph output on the sides.

  4. Found some typos in the text

jamesmrollins commented 3 years ago

Hi @staceypark - thanks for the review.

  1. I already have the font issue on my investigation list and am going to check it out.
  2. I will add more spacing to between the graphs, if possible.
  3. I will increase the size of the headings and the questions, and change the color of the questions to black.
  4. I see typos and will fix.
  5. I am having trouble recreating the PDF issue you show above, but will investigate it.

If we get these fixed tonight, do you want to follow the recommendations shown above?

staceypark commented 3 years ago

@jamesmrollins yes the above recommendations seem good to me to be in PROD by Friday/Monday morning.

Note for the RedCap <> Epicenter transfer of recreating r21 reports, we could just assign different responses to different known people. Folks wouldnt be going back to look at their indivdual responses & no one else but the facilitators/admin should ever be able to see who is associated with which response, so it doesnt ultimately matter if we don't assign the correct names to people, as long as we get the general team aggregated responses correct.

jamesmrollins commented 3 years ago

@staceypark Thanks for the clarification - I will make it so!

lijenn commented 3 years ago

TEST Instance - QA:

Feedback for @jamesmrollins

  1. James, for 'Enter Name' here, should it be email instead of name? image

EDIT: James will edit PROD ver. to include a first, last, and email field.

Capitalize the following:

  1. The h in "how overbooking or overworking.." image

  2. and H in 'Very high' image

Bold the following:

  1. Bold 'Psychotherapy' image

Language Edit:

  1. Learning Needs - Burnout Should say: Burnout - How to reduce provider burnout and improve patient satisfaction with care. image

  2. TT logo in myriad pro The tt logo still looks like its defaulting to times new roman or you could use this logo here? https://github.com/lzim/teampsd/blob/master/resources/logos/tt_title.png image

staceypark commented 3 years ago

@jamesmrollins here's my test:

image

  1. From the above second screenshot, I see the options to edit the team vision and arm, but I think we also need the ability to edit the team name in case someone gets it wrong, or it changes or something.

  2. After I created the team, I went to the dashboard and tried to queue the team up, but it does not show up in the dropdown. I refreshed the dashboard and it did.

    • can you either have it auto refresh once you close out of the Team set-up dialogue or add an instruction to do so for it to process
  3. I find it confusing that the logo for all of these are the same when they don't go to the same thing , and they don't function in the same way (meaning some of these are pop-out dialogues and some navigate you to a new page).

Screen Shot 2021-04-23 at 5 28 31 PM

image

image

  1. The PDF shows what my own choice is. I thought we decided it would not do that? Screen Shot 2021-04-23 at 6 31 58 PM

  2. I figured out that by using my facilitator-associated email on the MTL Menu login page, I can see the team's survey results and how many folks completed it. How does a facilitator view the comments sections (the "Other needs" questions). I'm not seeing it in this view either.

jamesmrollins commented 3 years ago

Hi @staceypark and @lijenn - Thank you for your review and comments. I have incorporated these items into the next push Sunday night, so should have them ready for Monday morning.

@staceypark regarding item 4. above, confusion regarding the logos. The gear indicates a set-up function (fairly universal) - True it doesn't go to its own full web page, but if we did that it would be an entire page with little content. So a pop up seemed more logical. Notwithstanding my comments, do you have any ideas on how we could handle that? I didn't want to put it into the facilitator part of the dashboard, because it isn't a facilitator function.

staceypark commented 3 years ago

from 4/26 wg leads:

@staceypark will test today 4/26 and update the shortlink to mtl.how/menu upon signoff for prod @lijenn will update the gifs and update the instructions in the mtl.how/teampsd_manual for anyone else to cover in the future

jamesmrollins commented 3 years ago

Hi @staceypark and @lijenn . Below is what I am tracking for matters related to this issue:

image

staceypark commented 3 years ago

@jamesmrollins @lijenn and I are reviewing right now. Few questions

  1. Related to the gear icon for MTL Demo/TeamPSD/Team Setup/TT

    • If we decided on a different icon later, how easy/hard is it to change?
    • I feel like all of the functions in the Admin login are "setup functions", but Jenn made a good point that all of the other ones are learner facing too (which is why we have specific icons for them). But those four are not learner facing buttons in the sim.
    • I think we had said at some point that we want the learners to be able to pull their own tt reports if they want? Do you remember this being true as well? And if so, we're going to want a specific icon for that. Otherwise, I think the gears are fine for now.
  2. Please edit this error message to say:

    • "Your team has not been set up to take the Modeling to Learn Menu. Please contact mtl.help@va.gov to set up your team." image
  3. The team set-up is buggy making sure team name ends in _team or _ind. I refreshed and it worked. image

  4. I noticed this list doesn't auto-sort by time or alphanumeric. Can you add buttons so the name and date/time columns can sort ascending & descending. image

  5. This still initially prompts to add name instead of email, first name, and last name. Once you add once person though, the first and last name fields start popping up. It's finicky. Also, once members are added, we are still only seeing the email address instead of all three pieces of information. image image

6, The add, edit, delete buttons look exactly the same for team setup and team member setup. It would be helpful if in the second pop-up where you add/edit/delete the team members, if it denoted as such (i.e. "Team Member Set-up) next to those three sets of buttons in the buttom half of that screen (refer to screenshots from #5 for reference.

  1. The image is a little wide. It needs to be narrower or taller. See original image for proportions. image

  2. The "b" in "Evidence-based" should be lowercase, but otherwise you got all the text fixes 🥳 image

  3. Is this in reference to the issue about the PDF not rendering properly?

    PDF report orphan control (cuts charts in half in printed report). The current PDF generator captures the entire screen as an image object. We have to figure out how to capture each chart as an image object, in order to control the page breaks. How to do this is not clear today, we must investigate further.

staceypark commented 3 years ago

@jamesmrollins regarding the above list of 10 issues. Unless #3 and #5 (or any other issues) will pose problems with user management, errors in completing the menu, or errors in retaining information about the menu (i.e. teams disappear, user answers disappear because their setup on the backend changes, etc.), then @lijenn and I don't see an issue with moving the shortlink to PROD for tomorrow's use for the team's Session 3 post email.

jamesmrollins commented 3 years ago

Hi @staceypark and @lijenn - Thanks for the detailed review. See my responses below. I don't think it will be a problem to get most of these up before tomorrow. Did you plan to set up the first team tomorrow? If so, I will prioritize the team functionality and turn on the email end user functionality in PROD.

@jamesmrollins @lijenn and I are reviewing right now. Few questions

  1. Related to the gear icon for MTL Demo/TeamPSD/Team Setup/TT
  • If we decided on a different icon later, how easy/hard is it to change? Easy Change
  • I feel like all of the functions in the Admin login are "setup functions", but Jenn made a good point that all of the other ones are learner facing too (which is why we have specific icons for them). But those four are not learner facing buttons in the sim.

True

  • I think we had said at some point that we want the learners to be able to pull their own tt reports if they want? Do you remember this being true as well? And if so, we're going to want a specific icon for that. Otherwise, I think the gears are fine for now. When the user navigates back to the mtl.how/menu, they will land in the latest report. If Report #2 has been published, then it will present when they login.
  1. Please edit this error message to say:
  • "Your team has not been set up to take the Modeling to Learn Menu. Please contact mtl.help@va.gov to set up your team." Got it, will be in place by tomorrow. image
  1. The team set-up is buggy making sure team name ends in _team or _ind. I refreshed and it worked.

I will check it out

image

  1. I noticed this list doesn't auto-sort by time or alphanumeric. Can you add buttons so the name and date/time columns can sort ascending & descending.

Got it. i will see if we can get in by tomorrow, but may prioritize it lower, depending on other things we are correcting.

image

  1. This still initially prompts to add name instead of email, first name, and last name. Once you add once person though, the first and last name fields start popping up. It's finicky. Also, once members are added, we are still only seeing the email address instead of all three pieces of information.

We didn't have time last night to put in the fix for this. Bottom line is it has been redesigned and we intend to construct that interface so it is much clearer.

image image

6, The add, edit, delete buttons look exactly the same for team setup and team member setup. It would be helpful if in the second pop-up where you add/edit/delete the team members, if it denoted as such (i.e. "Team Member Set-up) next to those three sets of buttons in the buttom half of that screen (refer to screenshots from #5 for reference.

Yes, this has been included in the re-design

  1. The image is a little wide. It needs to be narrower or taller. See original image for proportions.

Got it, will check it out.

image

  1. The "b" in "Evidence-based" should be lowercase, but otherwise you got all the text fixes 🥳

Got it

image

  1. Is this in reference to the issue about the PDF not rendering properly?

**PDF renders ok now, but just doesn't have orphan control."

PDF report orphan control (cuts charts in half in printed report). The current PDF generator captures the entire screen as an image object. We have to figure out how to capture each chart as an image object, in order to control the page breaks. How to do this is not clear today, we must investigate further.

jamesmrollins commented 3 years ago

@staceypark and @lijenn Update:

staceypark commented 3 years ago

decisions from 4/28 sim ui workgroup: we will add the team name and specific experiment names in the tt report (for both the recreated experiments and moving forward).

team name can be parsed from the "group/team name" entered into epicenter see #1900

jamesmrollins commented 3 years ago

Hi @staceypark and @lijenn

Problem

After some thinking this through - while we can parse the team name from the team name string from Team set up, we would have difficulty interpreting what needs to be capitalized. For example, if we take a sample team name like shown below and convert it with the rules shown below, the outputs would be:

Title Case: 666aaa_st_francis_bhip would be St Francis Bhip Upper Case: would be ST FRANCIS BHIP lower case: would be st francis bhip

I could look like:

image

Which do you prefer? It will be difficult, but not impossible, to create conditional logic to detect acronyms but we would need to assemble and maintain the listing (creating more work). I don't recommend this.

Recommendation

Recommend that we use the team name verbatim and post it on the lower bottom left of the report?

staceypark commented 3 years ago

@jamesmrollins I think we could either do title case (I think it looks fine like that) or do all lowercase since they're used to that in the sim already.

@lijenn what are your thoughts on it?

jamesmrollins commented 3 years ago

@lijenn @staceypark it would look like this:

image

lijenn commented 3 years ago

@jamesmrollins I think we should use all lower-case as Stacey mentioned to stay consistent with other parts of the Sim.

jamesmrollins commented 3 years ago

@lijenn @staceypark Lower case - Roger

image

jamesmrollins commented 3 years ago

DEV Completed with This Card

  1. Completed mtl.how/menu login functionality.
  2. Completed mtl.how/menu main page and facilitator dashboard, with missed question error control.
  3. Completed tt1 report page, with PDF print out capability. tt1 report page includes individual results in orange, that can be toggled off.
  4. Completed preliminary tt Admin functionality (pop up structure, team-model-experiment query and listing)

Work Moved to May Epic

  1. Development of mtl blue tt 2 report. #1956
  2. Development of the mtl red tt2 report. #1957
  3. Completion of the tt admin functionality. #1958
  4. r-notebook export functionality. #1959

Work Moved to June Epic

  1. Development of p-chart functionality in Sim UI. #1961
  2. Development of tt3 report - p-chart inclusion. #1962