Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VS-1483 Update AoU documentation to include details for VAT delivery #8967

Merged
merged 7 commits into from
Sep 9, 2024
14 changes: 13 additions & 1 deletion scripts/variantstore/docs/aou/AOU_DELIVERABLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,21 @@ The Callset Stats and S&P files can be simply `gsutil cp`ed to the AoU delivery
## Running the VAT pipeline
To create a BigQuery table of variant annotations, you may follow the instructions here:
[process to create variant annotations table](../../variant_annotations_table/README.md)

The pipeline takes in the VDS and outputs a variant annotations table in BigQuery.

Once the VAT table and a tsv is exported, the AoU research workbench team should be notified of its creation and permission should be granted so that several members of the team have view permission.

- Grant `BigQuery Data Viewer` permission to specific people's PMI-OPS accounts. As of the Echo release, these accounts were:
<ul>
<li>[email protected]</li>
<li>[email protected]</li>
<li>[email protected] </li>
<li>[email protected]</li>
<li>[email protected]</li>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we really want to put these emails in our docs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah - probably shouldn't but wasn't sure how to capture this level of detail.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe link back to a Confluence or something?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've linked to a Google Doc that tracks what we did for Echo

</ul>
- Copy the bgzipped, tarred export of the VAT into the pre-delivery bucket. For the Echo release, it was copied to `gs://prod-drc-broad/v8/wgs/vat/aou_srwgs_short_variants_v8r1.vat.bgz.tsv.gz`
- Finally, an email should be sent out notifying the AoU research workbench team (and others) of the readiness of the VAT. For echo, the email had the subject line: `Variant Annotations Table delivered for v8 srWGS joint callset` (it may just be easiest to find that email and modify it accordingly for the release you are working on.)
gbggrant marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Finally, an email should be sent out notifying the AoU research workbench team (and others) of the readiness of the VAT. For echo, the email had the subject line: `Variant Annotations Table delivered for v8 srWGS joint callset` (it may just be easiest to find that email and modify it accordingly for the release you are working on.)
- Finally, an email should be sent out notifying the AoU research workbench team (and others) of the readiness of the VAT. For echo, the email had the subject line: `Variant Annotations Table delivered for v8 srWGS joint callset` (it may just be easiest to find that email and modify it accordingly for the release you are working on).


## Additional Deliverables

### Smaller Interval Lists
Expand Down
Loading