CDR Tickets

Issue Number 3080
Summary Summary Comments Report
Created 2010-02-04 17:06:04
Issue Type Improvement
Submitted By Beckwith, Margaret (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2010-05-06 10:36:31
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107408
Description

BZISSUE::4756
BZDATETIME::2010-02-04 17:06:04
BZCREATOR::Margaret Beckwith
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku

THe Board Managers would like a report to view the Comments that have been inserted in the text of the summaries. I am attaching a spec/sample report.

Comment entered 2010-02-04 17:06:04 by Beckwith, Margaret (NIH/NCI) [E]

Attachment Summary Comments Report Sample.doc has been added with description: Sample of Summary Comments Report

Comment entered 2010-02-09 11:54:31 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-02-09 11:54:31
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::1

Added a few minor tweaks to the report sample.

Comment entered 2010-02-09 11:54:31 by Beckwith, Margaret (NIH/NCI) [E]

Attachment Summary Comments Report Sample.doc has been added with description: Updated Summary Comments Report Spec/sample

Comment entered 2010-02-09 11:56:08 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-02-09 11:56:08
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::2

Added updated sample of report.

Comment entered 2010-03-02 20:52:06 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-03-02 20:52:06
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

What should be the output format? HTML or Excel?

If we make this an HTML report we could easily color-code the different types of comments in the output.

In which order (within a summary) would the comments be displayed?

Comment entered 2010-03-04 11:47:53 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-03-04 11:47:53
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::4

I am not sure how to answer this in terms of the format. I think I am confused because many of our reports aren't in either HTML or Excel so I was thinking this would just look like a regular table. The order of the comments should be in the order in which they appear in the summary, and I don't think we need color coding. Maybe we could talk about this off line. Thanks.

Comment entered 2010-03-05 15:48:13 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-03-05 15:48:13
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::5

Now I have been set straight, so we want HTML for this report.

Comment entered 2010-03-22 18:14:43 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-03-22 18:14:43
BZCOMMENTOR::Volker Englisch
BZCOMMENT::6

This wasn't easy and it took - as usual - longer than expected. Also, I'm certain somebody will find things that I have overlooked but I'm taking a break from this report.
I've added a new option
Summaries Comments
to the board manager menu
BoardManagers.py

There are many options that can be selected for this report per requirements and I think I've tested most of them. It's now your turn to test this report called:
SummaryComments.py

This is ready for review on MAHLER.

Comment entered 2010-03-24 11:09:32 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-03-24 11:09:32
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::7

I think this looks just like what we want! I just have one question, and that is why are there commments not marked as I, E, or R?

Comment entered 2010-03-24 12:09:07 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-03-24 12:09:07
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8

Most of the comments are not marked at all. I think these are older comments that hadn't been entered by using the right-click mouse menu.
I am guessing that most of the comments on BACH will include the audience attribute but we certainly want to display all comments to give the board managers the chance to assign the audience attribute if none exists.

Comment entered 2010-03-25 11:56:27 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-03-25 11:56:27
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::9

Then let's promote it and I will put in another issue if something else is needed.

Comment entered 2010-03-26 18:39:14 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-03-26 18:39:14
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10

The following programs have been copied to FRANCK and BACH:
BoardManagers.py - R9555
SummaryComments.py - R9557

Please verify on BACH and close this bug.

Comment entered 2010-03-29 09:49:11 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-03-29 09:49:11
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::11

Looks great! Please promote. Sharon is going to be very happy!

Comment entered 2010-03-29 09:49:37 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-03-29 09:49:37
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::12

Sorry, I meant to say "issue closed"!

Comment entered 2010-04-19 10:56:52 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-04-19 10:56:52
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::13

Sharon noticed the following things with this report:
1) When I select HP->English->Pediatric Treatment, the report has comments for only 5 out of 23 summaries (Ch Brain and Spinal Cord Tumors Overview, Ch Brain Stem Glioma, Ch AML, Ch ALL and Ch Astrocytomas; alphabetically these are the first 5 pediatric treatment summary titles).
2) For most comments the Summary Section Title does not appear (the column has "Insertion" or "No Title for SummarySection found").
3) The internal, external, and response to comment comments display correctly with a few exceptions: (a) the internal Response to Comment in the Ch ALL/Treatment of Recurrent ALL/Prognostic Factors in Recurrent ALL section does not appear in the report, "The prognostic factors section for recurrent ALL should stay here and not be moved to the General Information section." (b) In the Ewing Sarcoma FOT summary a response to comment in the Extraosseous Ewing Sarcoma section does not appear (<ResponseToComment audience="Internal" date="2009-08-06" user="skasner">They were actually protocol IDs when I googled them. I revised the text. I cannot find a protocol link for them.sqk</ResponseToComment>). It seems that when there is a response to comment and the original comment has been deleted is when the response to comment does not show on the report.
4) The remaining summaries can all be accessed by entering their CDR ID number or searching on their title. The same issues with the Summary Section Title occur here as well.

Comment entered 2010-04-20 11:18:00 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-04-20 11:18:00
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::14

One more small thing that Sharon noticed:
5) If you type in the name of the summary in the interface to run the report, the report title says "PDQ None None Summary".

Comment entered 2010-04-20 15:24:32 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-04-20 15:24:32
BZCOMMENTOR::Volker Englisch
BZCOMMENT::15

(In reply to comment #13)
> 1) When I select HP->English->Pediatric Treatment, the report has comments
> for only 5 out of 23 summaries

This was a simple fix. For testing I limited the SELECT query to 5 documents and forgot to remove that restriction.

> 2) For most comments the Summary Section Title does not appear

Fixed.

> 3) It seems that when there is a response to comment and the original
> comment has been deleted is when the response to comment does not
> show on the report.

That is correct. I wasn't aware that a ResponseToComment could exist without
the Comment to respond to and therefore I had written the report in such a way
that I would only be looking for a ResponseToComment element if I found a
Comment element.
However, I've rewritten that part and now the two are not depending on each other anymore.

Comment entered 2010-04-20 15:25:31 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-04-20 15:25:31
BZCOMMENTOR::Volker Englisch
BZCOMMENT::16

(In reply to comment #14)
> 5) If you type in the name of the summary in the interface to run the report,
> the report title says "PDQ None None Summary".

This has been fixed as well.

I think I've addressed all issues now.
Please review on MAHLER.

Comment entered 2010-05-04 12:40:00 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-05-04 12:40:00
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::17

I forgot to mention that Sharon got a Python error when trying to run this on Mahler. I just tried and I get the same thing.

Comment entered 2010-05-04 13:33:11 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-05-04 13:33:11
BZCOMMENTOR::Volker Englisch
BZCOMMENT::18

What are the parameters Sharon is using to produce the error (HP/Patient; Summaries by type, title, ID; etc.)?

Comment entered 2010-05-04 17:22:02 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-05-04 17:22:02
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::19

I ran it for Pediatric Editorial Board, HP summaries, with External Comments and all the other check boxes checked.

Comment entered 2010-05-04 18:20:00 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-05-04 18:20:00
BZCOMMENTOR::Volker Englisch
BZCOMMENT::20

You just had to pick the one option that did not work. :-)
The problem was that there are a few comments that don't live within a SummarySection.

I adjusted this on MAHLER. Please review again.

Comment entered 2010-05-04 18:26:58 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-05-04 18:26:58
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::21

Looks good to me. Please promote and I will ask Sharon to look at it on Bach. Thanks.

Comment entered 2010-05-05 12:43:47 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-05-05 12:43:47
BZCOMMENTOR::Volker Englisch
BZCOMMENT::22

The following program has been copied to FRANCK and BACH:
SummaryComments.py - R9596

Please verify on BACH and close this bug.

Comment entered 2010-05-06 10:36:31 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2010-05-06 10:36:31
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::23

Sharon said this worked great on Bach. Issue closed.

Attachments
File Name Posted User
Summary Comments Report Sample.doc 2010-02-09 11:54:31
Summary Comments Report Sample.doc 2010-02-04 17:06:04

Elapsed: 0:00:00.001669