Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlicenJoyHenning authored Sep 23, 2024
1 parent a532d65 commit 8cb1040
Showing 1 changed file with 2 additions and 48 deletions.
50 changes: 2 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,59 +385,15 @@ SRR1234567 <- limiric(
<br>
<br>
##### 3. Combine ```limiric``` annotations with ```DropletQC```
Detect damaged cells and compare results with those from ```DropletQC```.
```R
SRR1234567 <- limiric(
project_name = "SRR1234567",
filtered_path = "/home/user/alignment/SRR1234567/filtered/",
droplet_qc = TRUE,
velocyto_path = "/home/user/alignment/velocyto/",
output_path = "/home/user/alignment/limiric/"
)
```
> **NB** This will change your output directory structure by adding a new ```DropletQC``` layer
>
> ```
> output_path/
> β”œβ”€β”€ CellQC
> |
> β”œβ”€β”€ DropletQC
> |
> β”œβ”€β”€ RBCQC
> |
> └── Filtered
> ```
>
<br>
<table>
<tr>
<td>
This will output a scatter plot and tSNE showing the cells annotated as damaged by both <code>limiric</code> and <code>DropletQC</code>.
</td>
<td>
<img src="https://github.com/AlicenJoyHenning/limiric/blob/master/inst/extdata/DropletQC.png" alt="Scatter plot" style="float: right; margin-left: 500px;" width="1000">
</td>
</tr>
</table>
<br>
##### 4. Combine previous condition
Perform ambient RNA correction with ```SoupX```, filter red blood cells, isolate immune cells, detect damaged cells, and compare against ```DropletQC```.
##### 3. Combine previous condition
Perform ambient RNA correction with ```SoupX```, filter red blood cells, isolate immune cells and detect damaged cells.
```R
SRR1234567 <- limiric(
project_name = "SRR1234567",
filtered_path = "/home/user/alignment/SRR1234567/filtered/",
soupx = TRUE,
raw_path = "/home/user/alignment/SRR1234567/raw/",
droplet_qc = TRUE,
isolate_cd45 = TRUE,
velocyto_path = "/home/user/alignment/velocyto/",
output_path = "/home/user/alignment/limiric/"
Expand All @@ -450,8 +406,6 @@ SRR1234567 <- limiric(
>
> β”œβ”€β”€ CellQC
> |
> β”œβ”€β”€ DropletQC
> |
> β”œβ”€β”€ IMCQC
> |
> β”œβ”€β”€ RBCQC
Expand Down

0 comments on commit 8cb1040

Please sign in to comment.