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

Add docs on the Illumina refinery #154

Merged
merged 1 commit into from
Aug 11, 2021

Conversation

jaclyn-taroni
Copy link
Member

Closes #153.

This adds text covering the Illumina refinery in our documentation.

It is largely adapted from the Illumina refinery README with a little more info/rationale thrown in.

(Side note: Is the If none of the associated gene IDs appear in any Brainarray platform, an NA is emitted point in that README now out of date? I thought so and didn't add it here.)

I also made a couple tweaks that I thought would help contextualize the newly added section.

Notes for reviewers

Copy link

@wvauclain wvauclain left a comment

Choose a reason for hiding this comment

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

Yes, this looks accurate to me.

I also removed the line about emitting NAs from the Illumina refinery README to match this.

Copy link
Member

@dvenprasad dvenprasad left a comment

Choose a reason for hiding this comment

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

Yep. We tell them the steps of the resolution and we link them to Github so they can poke further. The loops seem closed to me!

🦞 🦞 🦞


We infer the Illumina BeadArray platform that a sample is likely to be run on by comparing the probe identifiers in the unprocessed file to probes for each of the Illumina expression arrays for a given organism.
We again use the Illumina Bioconductor annotation packages for this step.
For instance, the overlap between the probe identifiers in a human sample and the probe identifiers in each human platform (<a href = "https://www.bioconductor.org/packages/release/data/annotation/html/illuminaHumanv1.db.html" target = "blank">`v1`</a>, <a href = "https://www.bioconductor.org/packages/release/data/annotation/html/illuminaHumanv2.db.html" target = "blank">`v2`</a>, <a href = "https://www.bioconductor.org/packages/release/data/annotation/html/illuminaHumanv3.db.html" target = "blank">`v3`</a>, and <a href = "https://www.bioconductor.org/packages/release/data/annotation/html/illuminaHumanv4.db.html" target = "blank">`v4`</a>) is calculated.
The platform with the highest overlap (provided it is >75%) is inferred to be the true platform.
Some analyses around this platform detection procedure can be found in <a href = "https://github.com/jaclyn-taroni/beadarray-platform-detection" target = "blank">this repository</a>.

##### Handling Illumina probes that map to multiple Ensembl gene identifiers
Copy link
Member

Choose a reason for hiding this comment

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

We're gonna be linking them here right?

Copy link
Member Author

Choose a reason for hiding this comment

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

That was my plan, yes!

Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

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

These look good to me! (Arbitrary but consistent FTW, unless you are dealing with children, in which case the poor kid at the end of the alphabet always seems to lose.)

@jaclyn-taroni
Copy link
Member Author

Thanks all!

@jaclyn-taroni jaclyn-taroni merged commit 4123bd6 into master Aug 11, 2021
@jaclyn-taroni jaclyn-taroni deleted the jaclyn-taroni/153-illumina-refinery branch August 11, 2021 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add information about the Illumina refinery
4 participants