Skip to content

Commit cc42ead

Browse files
Update README.md
1 parent 75a0494 commit cc42ead

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# BioInf
2-
Library for reading microbiology DNA files (ABI, SCF, FASTA, etc)
2+
Library for reading microbiology DNA files (ABI, SCF, FASTA, etc).
3+
Requires LightSaber base library.
4+
5+
Allows you to:
6+
* read/write SCF files
7+
* read ABI/AB/AB1/AB! files
8+
* read/write FASTA files
9+
* read/write GeneBank (GBK) files.
10+
11+
All this functionality is accessible with simple access to TCubeImport.Import(FileName)
12+
13+
TCube = class(TCubeAbstractSnp)
14+
public
15+
{IMPORT}
16+
function Import(CONST FileName: string): Boolean; { Fasta and GBK files are not supported because they may contain more than one sample! }
17+
function AssignGBK (CONST Gbk : TGbkObj): Boolean;
18+
function AssignScf (CONST SCF : TScfObj): boolean;
19+
function AssignAbi (CONST ABI : TAbiObj; EditedField: boolean= True): Boolean; { parametrul EditedFiled= arata de unde sa extraga informatia: din campul original sau din campul EDITED }
20+
function AssignSecv (CONST SECV: TFastaObj): Boolean;
21+
property Version: string read FParentVer Write FParentVer; { ce versiune a avut obiectul parinte. Exemplu, pt SCF: '3.00' }
22+
23+
{EXPORT}
24+
function ExportBack (CONST Clean: Boolean; OUT BasesLeft: Integer): Boolean; { Save the object back to disk, in its original format. This will overwrite the parent sample }
25+
function ExportAs (CONST aFileName: string; Clean: Boolean; OUT BasesLeft: Integer): Boolean; { Autodetecteaza tipul secventei din numele fisierului. QvAware=True transfera numai cu bazele QV bun }
26+
procedure ExportAsFASTA (CONST Clean: Boolean; OUT BasesLeft: Integer); overload; { uses cube's name and changes its extension to 'fasta' }
27+
procedure ExportAsFASTA (CONST FileName : string; Clean: Boolean; OUT BasesLeft: Integer); overload;
28+
procedure ExportAsSecv (CONST NewName : string; Clean: Boolean; OUT BasesLeft: Integer);
29+
procedure ExportToSCF (CONST aFileName: string; Clean: Boolean); overload; { This will remove all GAPs }
30+
function ExportToSCF (CONST Clean: Boolean): string; overload; { Returns the name used to save the file }
31+
function AsFasta (CONST aFileName: string; Clean: Boolean): TFastaObj; overload; { Return a TFastaObj object built from this cube }
32+
function AsFasta (CONST Clean: Boolean): TFastaObj; overload; { Same as above but the user doesnt have to provide a file name. It is automatically assumed from Cube's name }
33+
34+
procedure SaveChromaAsBmp(CONST Nume: string);
35+
end;

0 commit comments

Comments
 (0)