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

Feedback on Getting Started Vignette #18

Merged
merged 9 commits into from
Mar 22, 2024
Merged

Feedback on Getting Started Vignette #18

merged 9 commits into from
Mar 22, 2024

Conversation

howardbaik
Copy link
Contributor

I made a couple minor suggestions to the Getting Started vignette. I'll put additional feedback in inline comments below.

- `id`: an ID corresponding to the names of paired guides
- `seq_1`: gRNA sequence 1, targeting "paralog A"
- `seq_2`: gRNA sequence 2, targeting "paralog B"
- The sample, day, and replicate number for which gRNAs were sequenced (TODO)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was unclear what the last bullet point was saying. The column names in example_data that this point is referencing, Day00_RepA, Day05_RepA, Day22_RepA Day22_RepB Day22_RepC, doesn't seem to have any info on the sample. I think the names refer to the Day, and Replicate number, but not the sample.

I would list out each column and describe what each column is. For ex,

  • Day00_RepA: Gene Counts from Day 00 for Replicate A
  • Day05_RepA: Gene Counts from Day 05 for Replicate A
  • Day22_RepA: Gene Counts from Day 22 for Replicate A
  • Day22_RepB: Gene Counts from Day 22 for Replicate B

Copy link
Collaborator

Choose a reason for hiding this comment

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

This also sounds great! Can you add this?

@@ -19,24 +19,24 @@ knitr::opts_chunk$set(
gimap performs analysis of dual-targeting CRISPR screening data, with the goal of aiding the identification of genetic interactions (e.g. cooperativity, synthetic lethality) in models of disease and other biological contexts. gimap analyzes functional genomic data generated by the pgPEN (paired guide RNAs for genetic interaction mapping) approach, quantifying growth effects of single and paired gene knockouts upon application of a CRISPR library. A multitude of CRISPR screen types can be used for this analysis, with helpful descriptions found in this review (https://www.nature.com/articles/s43586-021-00093-4). Use of pgPEN and GI-mapping in a paired gRNA format can be found here (https://pubmed.ncbi.nlm.nih.gov/34469736/).

```{r}
library(magrittr)
library(dplyr)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we are going to use dplyr, we might as well load dplyr, which loads magrittr.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds good to me! Can you add this in too?

@cansavvy
Copy link
Collaborator

@howardbaek I like these suggestions, can you commit them?

Copy link
Collaborator

@cansavvy cansavvy left a comment

Choose a reason for hiding this comment

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

Hi @howardbaek thanks for bringing up these points and initiating the conversation at the meeting. I left some suggested wordings in this review, feel free to make adjustments for clarity as you see needed. But I think what you started here is great and very much needed!

Thanks!

vignettes/getting-started.Rmd Outdated Show resolved Hide resolved
vignettes/getting-started.Rmd Outdated Show resolved Hide resolved
vignettes/getting-started.Rmd Outdated Show resolved Hide resolved
vignettes/getting-started.Rmd Outdated Show resolved Hide resolved
vignettes/getting-started.Rmd Outdated Show resolved Hide resolved
vignettes/getting-started.Rmd Outdated Show resolved Hide resolved
- pg_metadata: paired guide metadata
- sample_metadata: Metadata of dataset where columns are different samples and rows are different paired guide.


Copy link
Collaborator

Choose a reason for hiding this comment

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

Probably can delete these extra lines.

Co-authored-by: Candace Savonen <cansav09@gmail.com>
@cansavvy
Copy link
Collaborator

Is this ready as far as you know @howardbaek ?

Copy link
Collaborator

@cansavvy cansavvy left a comment

Choose a reason for hiding this comment

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

Let's merge this!

@cansavvy
Copy link
Collaborator

Let's merge this!

Okay never mind. There's failing checks. Pull up pull up! I'm going to look into them.

@cansavvy cansavvy merged commit 547af90 into main Mar 22, 2024
6 of 7 checks passed
@cansavvy cansavvy deleted the howardbaek/feedback branch March 22, 2024 15:35
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.

2 participants