as-cle-bert commited on
Commit
d175e97
1 Parent(s): f3babf4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +50 -0
README.md CHANGED
@@ -1,3 +1,53 @@
1
  ---
2
  license: mit
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
  ---
4
+
5
+ # Dataset Card for VirBiCla-training
6
+
7
+ VirBiCla is a ML-based viral DNA detector designed for long-read sequencing metagenomics.
8
+
9
+ This dataset is a support dataset for training the base ML model.
10
+
11
+ ## Dataset Details
12
+
13
+ ### Dataset Description
14
+
15
+ - **Curated by:** [Astra Bertelli](https://astrabert.vercel.app/)
16
+ - **License:** MIT License
17
+
18
+ ### Dataset Sources [optional]
19
+
20
+ <!-- Provide the basic links for the dataset. -->
21
+
22
+ - **Repository:** [GitHub repository for VirBiCla](https://github.com/AstraBert/VirBiCla)
23
+
24
+ ## Uses
25
+
26
+ This dataset is intended as support for training the base VirBiCla model
27
+
28
+
29
+ ## Dataset Structure
30
+
31
+ Dataset is a CSV file composed of 60.003 record sequences (coming from RefSeq 16S bacterial rRNA, 18S fungal rRNA, SSU eukaryotic rRNA and RefSeq viral genomes) evaluated on 13 features.
32
+
33
+ Features are:
34
+
35
+ - Domain
36
+ - A, T, C and G proportion
37
+ - Percentage of A, T, C and G homopolimeric regions
38
+ - Gene density
39
+ - Entropy
40
+ - Effective Number of Codons (codon usage metrics)
41
+
42
+ ## Dataset Creation
43
+
44
+ Find everything that is needed for Dataset creation on [VirBiCla website](https://astrabert.github.io/VirBiCla)
45
+
46
+ ## Bias, Risks, and Limitations
47
+
48
+ The dataset is mainly directed towards amplicon-sequencing and long-read sequencing, which are the best use cases for VirBiCla.
49
+
50
+
51
+ ## Citation
52
+
53
+ Please consider cite the author of this work (Astra Bertelli) and VirBiCla [GitHub repository](https://github.com/AstraBert/VirBiCla) when using this dataset or the associated model.