CDR Tickets

Issue Number 5293
Summary Add PMIDs and Summary Board Information to Citations Linked From Summaries Report
Created 2023-10-19 16:32:51
Issue Type Improvement
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Kline, Bob (NIH/NCI) [C]
Status DEV Verified
Resolved 2023-11-20 10:25:46
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.364104
Description

I am wondering if it would be possible to add PMIDs and Summary Board Information to the Citations Linked From Summaries report. What I envisage is adding two new columns to the current columns. One for PMID and the other for the Summary Board in the Summary document.

Comment entered 2023-11-08 11:40:36 by Osei-Poku, William (NIH/NCI) [C]

I am wondering if you can add the summaries that the citations are linked from to the report as well. If this will make the report run too slow, then you can probably make it a batch report. If it will make the report too big (already it is a big or long report), then we can skip this request and look for a different solution later. The use case for this request is to be able to see all the summaries that are linking to a particular citation on the report, and not just the citations.ย  The summary information to add to the report would be the CDR ID (possibly linked to the Summary QC report) and Title of the summary.

Comment entered 2023-11-09 13:14:09 by Kline, Bob (NIH/NCI) [C]

...add the summaries that the citations are linked from ...

Here's an easy mnemonic to help with remembering the terminology connection with link directions. The question you want to ask yourself is "What's my destination?" The answer to that question is what the word "to" goes with.

Imagine you're standing in your kitchen and you realize you've run out of bread. You wouldn't say, "I think I'll drive up from the store." Instead, you'd say, "I think I'll drive up to the store," because the store is your destination.

Now imagine the analogous scenario with the user looking at a summary. When the user finds a citation link in that summary, does that user say "if I follow this link it will take me from the citation"? We hope not, because the citation (not the summary) is the destination for the link. The user is already looking at the summary, so the summary can't be the link's destination.

So for this report, we're showing the user links from summaries to citations, not the other way around.

Let's file another ticket to fix the title of this report, please. ๐Ÿ˜‰

I'm implementing the enhancements you've asked for.

Comment entered 2023-11-09 16:11:24 by Osei-Poku, William (NIH/NCI) [C]

Thanks for the explanation and clarification. Appreciated!

Comment entered 2023-11-09 16:37:55 by Kline, Bob (NIH/NCI) [C]

No problem. Basically, the summary is your kitchen, and the citation is the grocery store. ๐Ÿ˜ƒ

Comment entered 2023-11-20 07:09:41 by Kline, Bob (NIH/NCI) [C]

The rewritten report is finally ready for you to test on CDR DEV, . It takes about an hour to run, so it's now a queued batch job. As with theย URL Check report, I've added the ability to run a throttled version of the report directly for testing.

https://cdr-dev.cancer.gov/cgi-bin/cdr/CitationsInSummaries.py (might be typos in that URL, because I had to enter it by hand instead of copying it; I'm entering this comment on my own laptop, because I can't connect to JIRA when I'm on the VPN).

https://github.com/NCIOCPL/cdr-admin/commit/6bfa325
https://github.com/NCIOCPL/cdr-lib/commit/ea48e1e

Comment entered 2023-11-30 13:11:30 by Osei-Poku, William (NIH/NCI) [C]

Verified on DEV. Thanks! This is very helpful. I like the fact that you can run a quick sample report quickly.

Comment entered 2024-11-13 08:51:11 by Kline, Bob (NIH/NCI) [C]

Acceptance Criteria

  • CIAT/OCC > Other Document Types > Citations > Citations In Summaries

  • Enable the Quick sample report option

  • Click Submit

  • The Excel report spreadsheet should have six columns, including PMID and Summary Boards

Elapsed: 0:00:00.001793