search

PharmGKB / PharmCAT

The Pharmacogenomic Clinical Annotation Tool
Mozilla Public License 2.0
120 stars 39 forks source link

Update disclaimers text #59

Closed whaleyr closed 3 years ago

whaleyr commented 3 years ago

We need to update the Disclaimers text (disclaimers.hbs) at the bottom of the report to accurately reflect the current state of PharmCAT.

Things I can see so far:

  1. remove section D
  2. update section F to take out version number and update list of genes and drugs
  3. do we also need to update section C?
katrinsangkuhl commented 3 years ago

I have done this https://github.com/PharmGKB/PharmCAT/blob/development/docs/disclaimers.md

This is current to what we discussed. Do you pull from this or should I edit it some place else? The link to gene exception document doesn't seem to work

katrinsangkuhl commented 3 years ago

this is the updated gene exception https://github.com/PharmGKB/PharmCAT/blob/development/docs/methods/gene-definition-exceptions.md

whaleyr commented 3 years ago

Technically disclaimers.hbs and disclaimers.md are two different documents, though they may talk about the same thing.

disclaimers.hbs is the text that appears at the bottom of each HTML report.

disclaimers.md is the text displayed at https://pharmcat.org/disclaimers/

There is no direct linkage between the two. However, if the goal is to keep these two documents in sync then I can come up with a system to copy the content from disclaimers.md over to disclaimers.hbs. Is that what you want?

whaleyr commented 3 years ago

Never mind that last comment. After reading through the disclaimers.md it's pretty clear it's intended to be in the HTML report. I went ahead and replaced disclaimers.hbs with a rendered copy of the markdown and now they're in sync. That takes care of this issue, thanks for updating the text.