Skip to content

Commit

Permalink
README added
Browse files Browse the repository at this point in the history
  • Loading branch information
zixuanxie committed Aug 9, 2024
1 parent 66260a4 commit e70acc2
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# RDI
A Fast Algorithm for Calculating a Novel Degradation Index from RNA-seq Data
## Install RDI
To install RDI, download the source file RDI_0.0.0.9000.tar.gz, then run
```
install.packages("RDI_0.0.0.9000.tar.gz",repo=NULL,type="source")
```

## Run RDI
To run RDI, first create and index the reference transcriptome for calculating RDI
```
create_index(fasta_file, output_prefix) # fasta file is the reference transcriptome, for example GRCm38 for mouse
```
Then calculate RDI value for each sample
```
calculate_RDI(fq_file1, fq_file2, index_path, num_threads, output_dir)
```

0 comments on commit e70acc2

Please sign in to comment.