1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
|
package fai
import (
"fmt"
"io"
"os"
"github.com/edsrzf/mmap-go"
)
// MapWholeFile is a globle flag to decides whether map whole file
var MapWholeFile = true
var pageSize = int64(os.Getpagesize())
var pageSizeInt = os.Getpagesize()
// Faidx is
type Faidx struct {
file string
reader *os.File
Index Index
mmap mmap.MMap
}
// New try to get Faidx from fasta file
func New(fileSeq string) (*Faidx, error) {
fileFai := fileSeq + ".fai"
return NewWithCustomExt(fileSeq, fileFai)
}
// NewWithCustomExt try to get Faidx from fasta file, and .fai is specified
func NewWithCustomExt(fileSeq, fileFai string) (*Faidx, error) {
var index Index
if _, err := os.Stat(fileFai); os.IsNotExist(err) {
index, err = Create(fileSeq, fileFai)
if err != nil {
return nil, err
}
} else {
index, err = Read(fileFai)
if err != nil {
return nil, err
}
}
return NewWithIndex(fileSeq, index)
}
// NewWithIndex return faidx from file and readed Index.
// Useful for using custom IDRegexp
func NewWithIndex(file string, index Index) (*Faidx, error) {
reader, err := os.Open(file)
if err != nil {
return nil, fmt.Errorf("fail to open seq file: %s", err)
}
var m mmap.MMap
if MapWholeFile {
m, err = mmap.Map(reader, mmap.RDONLY, 0)
if err != nil {
return nil, fmt.Errorf("mmap err: %s", err)
}
}
return &Faidx{file, reader, index, m}, nil
}
// p is 0-based
func position(r Record, p int) int64 {
if p < 0 {
p = 0
}
if p > r.Length {
p = r.Length
}
return r.Start + int64(p/r.BasesPerLine*r.BytesPerLine+p%r.BasesPerLine)
}
// ErrSeqNotExists means that sequence not exists
var ErrSeqNotExists = fmt.Errorf("sequence not exists")
// SubSeq returns subsequence of chr from start to end. start and end are 1-based.
func (f *Faidx) SubSeq(chr string, start int, end int) ([]byte, error) {
sequence, err := f.SubSeqNotCleaned(chr, start, end)
if err != nil {
return nil, err
}
return cleanSeq(sequence), nil
}
// SubSeqNotCleaned returns subsequence of chr from start to end.
// start and end are 1-based.
// "\r" and "\n" are not cleaned.
func (f *Faidx) SubSeqNotCleaned(chr string, start int, end int) ([]byte, error) {
index, ok := f.Index[chr]
if !ok {
return nil, ErrSeqNotExists
}
if index.Length == 0 {
return []byte{}, nil
}
start, end, ok = SubLocation(index.Length, start, end)
if !ok {
return []byte{}, nil
}
pstart := position(index, start-1)
pend := position(index, end)
if MapWholeFile {
if pend > int64(len(f.mmap)) { // for truncated file
pend = int64(len(f.mmap))
}
return f.mmap[pstart:pend], nil
}
data := make([]byte, pend-pstart)
n, err := f.reader.ReadAt(data, pstart)
if err != nil {
if err == io.EOF { // for truncated file
return data[0:n], nil
}
return nil, err
}
return data, nil
}
// Seq returns sequence of chr
func (f *Faidx) Seq(chr string) ([]byte, error) {
sequence, err := f.SeqNotCleaned(chr)
if err != nil {
return nil, err
}
return cleanSeq(sequence), nil
}
// SeqNotCleaned returns sequences without cleaning "\r", and "\n"
func (f *Faidx) SeqNotCleaned(chr string) ([]byte, error) {
sequence, err := f.SubSeqNotCleaned(chr, 1, -1)
if err != nil {
return nil, err
}
return sequence, nil
}
// Base returns base in position pos. pos is 1 based
func (f *Faidx) Base(chr string, pos int) (byte, error) {
sequence, err := f.SubSeqNotCleaned(chr, pos, pos)
if err != nil {
return ' ', err
}
return sequence[0], nil
}
// Close the readers
func (f *Faidx) Close() error {
f.reader.Close()
if f.mmap == nil {
return nil
}
return f.mmap.Unmap()
}
/*SubLocation is my sublocation strategy,
start, end and returned start and end are all 1-based
1-based index 1 2 3 4 5 6 7 8 9 10
negative index 0-9-8-7-6-5-4-3-2-1
seq A C G T N a c g t n
1:1 A
2:4 C G T
-4:-2 c g t
-4:-1 c g t n
-1:-1 n
2:-2 C G T N a c g t
1:-1 A C G T N a c g t n
1:12 A C G T N a c g t n
-12:-1 A C G T N a c g t n
*/
func SubLocation(length, start, end int) (int, int, bool) {
if length == 0 {
return 0, 0, false
}
if start < 1 {
if start == 0 {
start = 1
} else if start < 0 {
if end < 0 && start > end {
return start, end, false
}
if -start > length {
return start, end, false
}
start = length + start + 1
}
}
if start > length {
return start, end, false
}
if end > length {
end = length
}
if end < 1 {
if end == 0 {
end = -1
}
end = length + end + 1
}
if start-1 > end {
return start - 1, end, false
}
return start, end, true
}
func cleanSeq(slice []byte) []byte {
newSlice := make([]byte, 0, len(slice))
for _, b := range slice {
switch b {
case '\r', '\n':
default:
newSlice = append(newSlice, b)
}
}
return newSlice
}
|