Assembly QA Part 1 DEV Steps

This page is currently a draft in progress. For now, use Releasing an assembly instead.

Navigation Menu Home Page Assembly QA Part 1: DEV Steps Assembly QA Part 2: BETA Steps Assembly QA Part 3: RR Steps Assembly QA Part 4: Post Release Steps

Dev 1.0. Getting started in hive

During this assembly release process, you will be generating a lot of output, and you'll need a place to put everything. The use of the "hive" directory is encouraged as the best location because of ample space.

Dev 1.1. Make a directory in your hive

 
mkdir /hive/users/userName/assemblies/assemblyName  

e.g.:  mkdir /hive/users/cath/assemblies/manPen1

Dev 1.2. Optional: Create an alias to your new dir

When you add an alias from your .bashrc file, you can simply type that alias in your command line as a shortcut to the associated command. A "shortcut" alias can be created to allow fast access to your hive directory for this assembly.

To do this, follow the steps below:

1. In your terminal, connect to hgwdev and type "cd" (go to your home directory).
2. Confirm the location of .bashrc. Type "ls -a" in your home directory to see all hidden files that have a " . " in the filename. This way you can confirm the location of your .bashrc file.
3. Open your .bashrc file for editing. If you're using the vi editor, you can type "vi .bashrc" to edit the file. Add an alias by typing in the line below, then save your changes.

alias hive='cd /hive/users/yourUserName/assemblies/yourAssembly'

e.g., alias hive='cd /hive/users/cath/assemblies/manPen1'

Dev 2.0: Getting started in Redmine

1. Find your assembly in the associated Assembly Redmine ticket.
   1. If there is no Redmine ticket for your assembly, you should create one.
   2. If a Redmine ticket for your assembly already exists, read through it carefully.
   3. For any issues found in the QA process, report in the Redmine ticket.

Dev 2.1. Redmine: Set 'assignee' as yourself

Dev 2.2. Redmine: Set the engineer as "watcher"

Dev 3.0: Check "minimal browser" criteria

Under construction: Jairo

Does this assembly have the required tracks?

Visit this page to check that the assembly contains the required tracks to be considered a minimal browser on the RR.

To add explaination: genbank mrnas & ests (/cluster/data/genbank/data/organism.lst) How to view/interpret the file

Dev 3.1: BLAT Servers

To check if your organism has Blatservers setup, run the following command:

hgwdev > copyHgcentral test $db blatServers dev beta

The developer has often already requested that the blat servers be set up for the new assembly. If not, and/or if entries for your assembly are missing from hgcentraltest.blatServers, please make a note in the Redmine ticket and ask the assembly builder to 1) request the setup of the blat servers and to 2) manually add the entries to hgcentraltest.blatServers. Make sure that this assembly is not hosted on "blatx" BLAT server. That server is not as stable and therefore is for assemblies that are not destined for the RR. For more information about where the blat servers for different machines should be hosted, go to Updating blat servers.

Dev 4.0: Getting started in the PushQ

Dev 4.1. PushQ: Set 'assignee' as yourself

1. Find your assembly in the PushQ
   1. Click on the link in the "Queue ID" column
   2. Click the "lock" button at the top of the page to "unlock" the fields for editing.
   3. Add your name to the "Reviewer" column.
   4. Press the "Submit" button to save your edits.

Dev 4.2. PushQ: Check validity of alignment tables

section under construction - cath

This step ensures that all associated alignment (chain/net/liftOver) files are to other VALID assemblies on the RR.

1. Go to the pushQ and click on the "Gateway" link at the top of the page.
2. In the Gateway Queue is a list of assemblies. Click on your assembly to enter the "Track Push Queue for yourAssembly."
3. Search for Chain/Net on the page and note the file names.
4. Next, go to /gbdb and see what liftOver files exist for your assembly. For example,

cd /gbdb/manPen1/liftOver

or, from the location /gbdb on hgwdev:

ls -d */liftOver/*hg38*

If your assembly has chain/net/liftOver to/from an assembly that is *not* on the RR (and not in the pushQ as an upcoming new assembly), you do not need to QA them or push them to the RR. Drop the relevant row(s) from your sub-pushQ by going to the track entry, clicking lock and then clicking the delete button.

Below is a description of alignment files, for example, human (hg38) and lizard (anoCar2). Hiram has suggested to go to this directory and read more about the file types here:

less /hive/data/genomes/hg38/bed/lastzAnoCar2.2015-02-05/axtChain/netChains.csh

LiftOver Files

A liftOver file is a chain file, it is a subset of all chains used in creating the net file.

hg38ToAnoCar2.over.chain.gz: These files are required for the liftOver utility.

The file names reflect the assembly conversion data contained within in the format <db1>To<Db2>.over.chain.gz. For example, a file named hg38ToAnoCar2.over.chain.gz file contains the liftOver data needed to convert hg38 coordinates to the anoCar2 assembly.

Chain Files

Chain files contain all possible chains generated by lastz, before a subset of "best" chains are filtered into the liftOver file.

hg38.anoCar2.all.chain.gz: chained blastz alignments.

The chain format is described in on the chain help page.

Net Files

hg38.anoCar2.net.gz: "net" file.

This file describes rearrangements between the species and the best Lizard match to any part of the Human genome. The net format is described in on the net help page.

Axt Files

hg38.anoCar2.net.axt.gz: chained and netted alignments.

i.e. the best chains in the Human genome, with gaps in the best chains filled in by next-best chains where possible. The axt format is described in the axt help page.

Dev 4.3. PushQ: Copy sub-pushQ tracks to your track checklist

NEED TO ADD STEPS HERE. Not part of assembly checklist template yet. Will QA tracks as the very last DEV step before moving on to BETA steps.

Dev 5.0: Compare Chrom Sizes

CHRIS V TO EDIT

Ignore this if assembly is the first for a species.

For a new assembly version, compare the chrom sizes from the last assembly to this new assembly version. You are not checking annotations on the reference sequence, you are just checking the number of base pairs per chrom/contig, and making sure that nothing has changed drastically (i.e., millions of base pairs different). Also take a look for general differences, such as chrom labels or number of chrom/contigs.

Output chrom sizes into two files, sort each file by using the command below

Compare the sorted files

There are two ways to compare chromosomes:

1.Navigate to http://hgwdev.cse.ucsc.edu/cgi-bin/hgGateway, find your assembly and click on the "View Sequences" button - bring up 2 windows side by side to view both old and new assemblies. Now, you can compare the chromosome sizes.

or

2. open up a terminal window and input the following commands:

hgwdev > hgsql -Ne "select chrom, size from chromInfo" $oldDb > oldChromSizes assemblyName (e.g., "panTro4")
hgwdev > hgsql -Ne "select chrom, size from chromInfo" $newDb > newChromSizes assemblyName (e.g., "panTro5")
hgwdev > sdiff -s oldChromSizes newChromSizes

You may want to use "$cat oldChromSizes | head" to clean up the output in both old and new chromSize files, we are only concerned with the "chr# ####" labels.

Dev 6.0: Gateway Page Checks

Dev 6.1. Check default position

Dev 6.2. Alphabetical menu order

Dev 6.3. Organism image check

Dev 6.4. Accesion ID check

Assemblies/sequences, from various organizations, are submitted to the mother ship GenBank.
Those assemblies might be included in RefSeq if criteria are met.

The QA check should be to go out to NCBI and double check that the accessionID is correct.

RefSeq assemblies:

use accession ID: GCF_000002315.4 (e.g., galGal5)

are delivered with chrMt (if they exisit)

are delivered with NCBI gene predictions

Genbank assemblies:

use accession ID: GCA_000001305.2

delivered without a chrMt.

do not have gene predictions.

For the UCSC Genome Browser, it is preferable to use RefSeq assemblies (in part due to 'more data'). This is a "learn as we go" direction; historically GeneBank was preferred.

Helpful article: Nature, 2012 A beginner's guide to eukaryotic genome annotation

Dev 7.0: md5sum Checks

Under construction by Jairo.

We need to verify that the download files exist and are not corrupt in the following directory:

hgwdev > /usr/local/apache/htdocs-hgdownload/goldenPath/$db/

Before we begin, create a junk folder in your home directory:

mkdir ~/temp

We will be using a computer program called Md5sum to generate MD5 hashes to verify the integrity of the files since any change to the file will cause its MD5 hash to change. The MD5 hashes for each file was generated and stored in the md5sum.txt file.

An easy way to compare the MD5 hashes of each file is to do a diff. This can be easily automated by running the following commands.

The first command is to run md5sum for all files in your current directory, sort them, and then redirect the output to a file.

md5sum * | sort > ~/temp/filename_1

The second command sorts the md5sum.txt file and redirects the output to a different file.

sort md5sum.txt > ~/temp/filename_2

The final command compares the two files created and displays the lines that differ between the two files.

diff ~/temp/filename_1 ~/temp/filename_2

Note that the md5sum.txt file obviously does not contain md5sum.txt and it was created before there was a README.txt file, so your diff will show md5sum.txt and README.txt in the results. If everything is ok, those should be the only results. In the vs* directories, the XXXX.net.axt.gz file will show up as axtNet/XXXX.net.axt.gz.

Dev 7.1. Check md5sum for /bigZips

Change your directory to:

hgwdev > /usr/local/apache/htdocs-hgdownload/goldenPath/$db/bigZips

then run the following command:

md5sum * | sort > ~/temp/filename_1; sort md5sum.txt > ~/temp/filename_2; diff ~/temp/filename_1 ~/temp/filename_2

Dev 7.2. Check md5sum for /liftOver

Change your directory to:

hgwdev > /usr/local/apache/htdocs-hgdownload/goldenPath/$db/liftOver

then run this command:

md5sum * | sort > ~/temp/filename_1; sort md5sum.txt > ~/temp/filename_2; diff ~/temp/filename_1 ~/temp/filename_2

Dev 7.2. Check md5sum for /vsXXX

This section is only relevant if your assembly has chain/net files to another organism.

Change your directory to:

hgwdev > /usr/local/apache/htdocs-hgdownload/goldenPath/$db/vsXXX

then run the following command:

md5sum * | sort > ~/temp/filename_1; sort md5sum.txt > ~/temp/filename_2; diff ~/temp/filename_1 ~/temp/filename_2

Dev 8.0: README.txt Checks

Under construction by Jairo.

Check that we have READMEs at top level, and for bigZips, chromosomes, liftOvers and comparatives (multiz, phastCons, vsXXX). Verify that the information in the READMEs is correct. Note that some of the files mentioned in the README are generated by the Genbank process, so they won't be present yet. The genbank process will build the upstream* files on hgdownload if they don't exist, or are more than seven days old, with whatever genePred table is defined in etc/genbank.conf (e.g. hg16.upstreamGeneTbl = refGene ). Make sure that the README for the upstream* files reflects the genePred table listed for this assembly.

Dev 8.1. bigZip: readme

Dev 8.2. database: readme

Dev 8.3. liftOver: readme

Dev 8.4. vsXXX: README

Dev 9.0: corruption Checks

Under construction by Jairo.

Dev 9.1. bigZip: corruption

Check that the files in each bigZips, liftOver, vsXXX don't contain weird characters. Run the following in each directory and check the output: for file in *; do zcat $file | head; zcat $file | tail; done Scroll the output and make sure all the text is ASCII. If there are any issues alert the developer.

Dev 9.2. database: corruption

Check that the files in each bigZips, liftOver, vsXXX don't contain weird characters. Run the following in each directory and check the output: for file in *; do zcat $file | head; zcat $file | tail; done Scroll the output and make sure all the text is ASCII. If there are any issues alert the developer.

Dev 9.3. liftOver: corruption

Check that the files in each bigZips, liftOver, vsXXX don't contain weird characters. Run the following in each directory and check the output: for file in *; do zcat $file | head; zcat $file | tail; done Scroll the output and make sure all the text is ASCII. If there are any issues alert the developer.

Dev 9.4. vsXXX: corruption

Check that the files in each bigZips, liftOver, vsXXX don't contain weird characters. Run the following in each directory and check the output: for file in *; do zcat $file | head; zcat $file | tail; done Scroll the output and make sure all the text is ASCII. If there are any issues alert the developer.

Dev 10.0: liftOver files exist?

Dev 10.1. liftOver: new-to-old

Dev 10.2. liftOver: old-to-new

Dev 11.0: downloads permissions check

Dev 12.0: Do Track QA for all relevant tracks

• Follow the [New_track_checklist | New Track Checklist] on the wiki.
• NOTE TO SELF - Explain which tracks don't need checking, this is confusing for new employees.

.

.

🔵 Done with DEV steps? Go to Assembly QA Part 2: BETA Steps