Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
How to add reference genomes
  • Loading branch information
kojix2 authored Jan 11, 2023
1 parent c897deb commit d2e102c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,18 @@ hg38 = Bio::TwoBit::Hg38.new
hs1 = Bio::TwoBit::Hs1.new
```

Adding a new reference file is easy. Add [here](https://github.com/ruby-on-bioc/bio-twobit/blob/main/lib/bio/twobit/references/template.erb) the id of the genome you want to use. Pull requests are welcome.
Adding a new reference genome is easy. Add [here](https://github.com/ruby-on-bioc/bio-twobit/blob/main/lib/bio/twobit/references/template.erb) the id of the genome you want to use.

```
git clone https://github.com/ruby-on-bioc/bio-twobit
vi lib/bio/twobit/references/template.erb # Add your id to ids list.
ruby lib/bio/twobit/references/template.erb
rake install
```

If you want to use 2-bit files from locations other than UCSC, create your own classes [here](https://github.com/ruby-on-bioc/bio-twobit/tree/main/lib/bio/twobit/references).

Pull requests are welcome.

## Development

Expand Down

0 comments on commit d2e102c

Please sign in to comment.