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

Updated documentation #64

Merged
merged 3 commits into from
Mar 2, 2016
Merged

Updated documentation #64

merged 3 commits into from
Mar 2, 2016

Conversation

map222
Copy link
Contributor

@map222 map222 commented Feb 25, 2016

My lab is interested in the table output from sleuth to identify genes of interest. I worked on the documentation for sleuth_results, sleuth_to_matrix, and sleuth_gene_table. I added more information on the columns of the data frames that are output, based on descriptions from the google groups.

I also added example code that shows how to figure out conditions using models(), and examples of how to inspect initial results.

If this looks good, I can try to go through the other popular functions, and update the documentation.

Also, sleuth_gene_table uses the lrt test by default, while most of the rest of the functions use wt, which is somewhat confusing.

@map222 map222 mentioned this pull request Feb 25, 2016
For sleuth_gene_table, sleuth_results, and sleuth_to_matrix
@pimentel
Copy link
Collaborator

I just realized this a few days ago -- totally and oversight/artifact of development and testing (the comment about sleuth_gene_table). Thanks for pointing this out.

Anyway, this looks fantastic! I will take a very careful look later tonight and merge it. Thanks so much!

@map222
Copy link
Contributor Author

map222 commented Feb 25, 2016

Another quick question. In sleuth_gene_table, is num_transcripts summed over all transcripts and all samples for a given gene? Some of the transcript numbers I saw were quite low (<10), which was surprising to me, but may be standard for RNA-seq.

Updated sleuth_gene_table, sleuth_prep, sleuth_wt, sleuth_fit, and
models.
@pimentel
Copy link
Collaborator

@map222 sorry for the delay on the merge. will hopefully actually happened today.

anyway, you are correct. it is the total number of transcripts that have the same gene name. This certainly depends on your annotation. The mean number of transcripts purging is much lower for the RefSeq annotation compared to the Ensembl annotation.

More precise definition of num_transcripts
@pimentel
Copy link
Collaborator

pimentel commented Mar 2, 2016

Sorry for the delay. Looking it over right now.

@pimentel pimentel merged commit 3cde4f6 into pachterlab:master Mar 2, 2016
@pimentel
Copy link
Collaborator

pimentel commented Mar 2, 2016

Thanks a bunch for this, @map222 ! Good stuff!

@map222
Copy link
Contributor Author

map222 commented Mar 2, 2016

Thanks! Writing the documentation helped me better understand what was actually going on.

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.

None yet

2 participants