@genobank/biofs 1.2.6 → 1.2.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ANNOTATOR_RECOMMENDATIONS_API.md +490 -0
- package/BIOFS_V1.2.7_PUBLISHED.md +317 -0
- package/BIOOS_CLI_IMPLEMENTATION_COMPLETE.md +422 -0
- package/BIOOS_JOB_MANAGEMENT.md +681 -0
- package/INSTALL_V1.2.7_ON_MAC.md +306 -0
- package/OPENCRAVAT_ANNOTATORS_REFERENCE.md +340 -0
- package/OPENCRAVAT_ANNOTATOR_INTELLIGENCE_COMPLETE.md +479 -0
- package/README.md +27 -0
- package/RELEASE_SUMMARY_V1.2.7.md +479 -0
- package/dist/commands/job/create.d.ts +7 -0
- package/dist/commands/job/create.d.ts.map +1 -0
- package/dist/commands/job/create.js +108 -0
- package/dist/commands/job/create.js.map +1 -0
- package/dist/commands/job/list.d.ts +7 -0
- package/dist/commands/job/list.d.ts.map +1 -0
- package/dist/commands/job/list.js +135 -0
- package/dist/commands/job/list.js.map +1 -0
- package/dist/commands/job/pipelines.d.ts +5 -0
- package/dist/commands/job/pipelines.d.ts.map +1 -0
- package/dist/commands/job/pipelines.js +77 -0
- package/dist/commands/job/pipelines.js.map +1 -0
- package/dist/commands/job/results.d.ts +6 -0
- package/dist/commands/job/results.d.ts.map +1 -0
- package/dist/commands/job/results.js +101 -0
- package/dist/commands/job/results.js.map +1 -0
- package/dist/commands/job/status.d.ts +6 -0
- package/dist/commands/job/status.d.ts.map +1 -0
- package/dist/commands/job/status.js +139 -0
- package/dist/commands/job/status.js.map +1 -0
- package/dist/index.js +94 -2
- package/dist/index.js.map +1 -1
- package/dist/lib/api/client.d.ts +9 -0
- package/dist/lib/api/client.d.ts.map +1 -1
- package/dist/lib/api/client.js +58 -0
- package/dist/lib/api/client.js.map +1 -1
- package/opencravat_annotators_dictionary.json +2356 -0
- package/package.json +1 -1
- package/scripts/build_annotator_dictionary.py +352 -0
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
# BioFS v1.2.7 - Published to npm ✅
|
|
2
|
+
|
|
3
|
+
## 🎉 Successfully Published!
|
|
4
|
+
|
|
5
|
+
**Package**: `@genobank/biofs@1.2.7`
|
|
6
|
+
**npm Registry**: https://www.npmjs.com/package/@genobank/biofs
|
|
7
|
+
**Published**: October 7, 2025
|
|
8
|
+
**Package Size**: 154.4 KB
|
|
9
|
+
**Unpacked Size**: 714.2 KB
|
|
10
|
+
**Total Files**: 192
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
### Quick Install (Recommended)
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install -g @genobank/biofs@1.2.7
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Verify Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
biofs --version # Should show: 1.2.7
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## What's New in v1.2.7
|
|
27
|
+
|
|
28
|
+
### 🧬 OpenCRAVAT Annotator Intelligence (NEW!)
|
|
29
|
+
|
|
30
|
+
**Complete Dictionary System**:
|
|
31
|
+
- **146 annotators** catalogued and categorized
|
|
32
|
+
- **12 categories**: clinical_significance, cancer, population_frequency, variant_effect_prediction, pharmacogenomics, mendelian_disease, splicing, regulatory, conservation, pathways, protein_function, other
|
|
33
|
+
- **7 phenotype recommendations**: cancer, cardiovascular, hereditary_cancer, rare_disease, pharmacogenomics, autism, developmental_delay
|
|
34
|
+
- **4 analysis type recommendations**: rare_coding, splicing, regulatory, de_novo
|
|
35
|
+
|
|
36
|
+
**API Endpoints Added**:
|
|
37
|
+
1. `GET /api_bioos/annotator_recommendations?phenotype={type}` - Smart recommendations
|
|
38
|
+
2. `GET /api_bioos/annotator_dictionary?category={cat}` - Browse all annotators
|
|
39
|
+
|
|
40
|
+
**Example Usage**:
|
|
41
|
+
```bash
|
|
42
|
+
# Get cancer-specific annotators
|
|
43
|
+
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=cancer"
|
|
44
|
+
# Returns: clinvar, cosmic, cancer_genome_interpreter, cancer_hotspots, civic, oncokb, chasmplus, gnomad, alphamissense, revel
|
|
45
|
+
|
|
46
|
+
# Get rare disease annotators
|
|
47
|
+
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=rare_disease"
|
|
48
|
+
# Returns: clinvar, clinvar_acmg, omim, hpo, gnomad, alphamissense, cadd, sift, polyphen2, spliceai
|
|
49
|
+
|
|
50
|
+
# Get splicing-specific annotators
|
|
51
|
+
curl "https://genobank.app/api_bioos/annotator_recommendations?analysis_type=splicing"
|
|
52
|
+
# Returns: clinvar, spliceai, dbscsnv, gnomad
|
|
53
|
+
|
|
54
|
+
# Look up specific annotator
|
|
55
|
+
curl "https://genobank.app/api_bioos/annotator_dictionary?name=alphamissense"
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Natural Language Mapping for Claude API**:
|
|
59
|
+
|
|
60
|
+
| User Says | Claude Maps To | Annotators Selected |
|
|
61
|
+
|-----------|----------------|---------------------|
|
|
62
|
+
| "find cancer variants" | `phenotype=cancer` | cosmic, civic, oncokb, chasmplus |
|
|
63
|
+
| "rare coding variants" | `analysis_type=rare_coding` | gnomad, alphamissense, revel, cadd |
|
|
64
|
+
| "splice site mutations" | `analysis_type=splicing` | spliceai, dbscsnv |
|
|
65
|
+
| "autism spectrum disorder" | `phenotype=autism` | clinvar, omim, hpo, denovo |
|
|
66
|
+
|
|
67
|
+
### 🔬 BioOS Job Management (from v1.2.6)
|
|
68
|
+
|
|
69
|
+
- Natural language job creation: `biofs job create "Annotate VCF with rare coding variants" sample.vcf`
|
|
70
|
+
- Real-time monitoring: `biofs job status <job_id> --watch`
|
|
71
|
+
- Pipeline templates: `biofs job pipelines`
|
|
72
|
+
- Story Protocol IP lineage tracking
|
|
73
|
+
- Presigned S3 download URLs
|
|
74
|
+
- SHA256 file verification
|
|
75
|
+
|
|
76
|
+
### 🎨 Enhanced User Experience
|
|
77
|
+
|
|
78
|
+
- Progress bars for job execution
|
|
79
|
+
- Color-coded status indicators
|
|
80
|
+
- Formatted tables for data display
|
|
81
|
+
- JSON output for all commands
|
|
82
|
+
|
|
83
|
+
## Available Commands
|
|
84
|
+
|
|
85
|
+
### Authentication
|
|
86
|
+
```bash
|
|
87
|
+
biofs login # Web3 wallet authentication
|
|
88
|
+
biofs logout # Clear credentials
|
|
89
|
+
biofs whoami # Show current wallet
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### File Management
|
|
93
|
+
```bash
|
|
94
|
+
biofs files # List your BioFiles
|
|
95
|
+
biofs download <file> # Download files
|
|
96
|
+
biofs upload <file> # Upload files
|
|
97
|
+
biofs tokenize <file> # Tokenize as BioIP NFT
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### BioOS Job Management
|
|
101
|
+
```bash
|
|
102
|
+
biofs job pipelines # List available templates
|
|
103
|
+
biofs job create "prompt" <file> # Create research job
|
|
104
|
+
biofs job status <job_id> [--watch] # Check status
|
|
105
|
+
biofs job results <job_id> # Get results
|
|
106
|
+
biofs job list [--status <status>] # List all jobs
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Access Control
|
|
110
|
+
```bash
|
|
111
|
+
biofs access request <biocid> # Request access
|
|
112
|
+
biofs access grant <biocid> <wallet> # Grant access (owner)
|
|
113
|
+
biofs access revoke <biocid> <wallet> # Revoke access (owner)
|
|
114
|
+
biofs access list [biocid] # List permissions
|
|
115
|
+
biofs access check <biocid> # Check your access
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Testing the New Features
|
|
119
|
+
|
|
120
|
+
### Test Annotator Intelligence
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
# Get recommendations for cancer analysis
|
|
124
|
+
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=cancer"
|
|
125
|
+
|
|
126
|
+
# Get recommendations for rare disease
|
|
127
|
+
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=rare_disease"
|
|
128
|
+
|
|
129
|
+
# Browse all 146 annotators
|
|
130
|
+
curl "https://genobank.app/api_bioos/annotator_dictionary"
|
|
131
|
+
|
|
132
|
+
# Look up AlphaMissense
|
|
133
|
+
curl "https://genobank.app/api_bioos/annotator_dictionary?name=alphamissense"
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Create a Job with Smart Annotator Selection
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
# Natural language - Claude API picks annotators
|
|
140
|
+
biofs job create "Find pathogenic variants in BRCA1/BRCA2" sample.vcf
|
|
141
|
+
# Claude uses: phenotype=hereditary_cancer
|
|
142
|
+
# Selects: clinvar, brca1_func_assay, cosmic, alphamissense
|
|
143
|
+
|
|
144
|
+
# Specific analysis type
|
|
145
|
+
biofs job create "Analyze splice variants" sample.vcf
|
|
146
|
+
# Claude uses: analysis_type=splicing
|
|
147
|
+
# Selects: clinvar, spliceai, dbscsnv, gnomad
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Documentation Included
|
|
151
|
+
|
|
152
|
+
1. **OPENCRAVAT_ANNOTATORS_REFERENCE.md** - All 146 annotators categorized
|
|
153
|
+
2. **ANNOTATOR_RECOMMENDATIONS_API.md** - API documentation
|
|
154
|
+
3. **OPENCRAVAT_ANNOTATOR_INTELLIGENCE_COMPLETE.md** - Implementation guide
|
|
155
|
+
4. **BIOOS_JOB_MANAGEMENT.md** - Job management guide
|
|
156
|
+
5. **INSTALL_V1.2.7_ON_MAC.md** - Installation instructions
|
|
157
|
+
|
|
158
|
+
## Files Included in Package
|
|
159
|
+
|
|
160
|
+
### Core CLI (TypeScript compiled to JavaScript)
|
|
161
|
+
- Complete authentication flow
|
|
162
|
+
- BioFiles management
|
|
163
|
+
- BioIP tokenization
|
|
164
|
+
- BioOS job orchestration
|
|
165
|
+
- Access control
|
|
166
|
+
|
|
167
|
+
### Annotator Intelligence
|
|
168
|
+
- `opencravat_annotators_dictionary.json` - 146 annotators
|
|
169
|
+
- `scripts/build_annotator_dictionary.py` - Dictionary builder
|
|
170
|
+
|
|
171
|
+
### Test Files
|
|
172
|
+
- `test.vcf` - Sample VCF
|
|
173
|
+
- `test_23andme.txt` - Sample 23andMe data
|
|
174
|
+
- `test-complete-flow.sh` - Integration test
|
|
175
|
+
|
|
176
|
+
## Troubleshooting
|
|
177
|
+
|
|
178
|
+
### Update from Previous Version
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
# Uninstall old version
|
|
182
|
+
npm uninstall -g @genobank/biofs
|
|
183
|
+
|
|
184
|
+
# Install new version
|
|
185
|
+
npm install -g @genobank/biofs@1.2.7
|
|
186
|
+
|
|
187
|
+
# Verify
|
|
188
|
+
biofs --version # Should show 1.2.7
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### Permission Errors
|
|
192
|
+
|
|
193
|
+
```bash
|
|
194
|
+
# Use sudo on Mac
|
|
195
|
+
sudo npm install -g @genobank/biofs@1.2.7
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### Clear Cache if Needed
|
|
199
|
+
|
|
200
|
+
```bash
|
|
201
|
+
npm cache clean --force
|
|
202
|
+
npm install -g @genobank/biofs@1.2.7
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
## API Infrastructure
|
|
206
|
+
|
|
207
|
+
### Production API Endpoints
|
|
208
|
+
- **Base URL**: https://genobank.app/api_bioos/
|
|
209
|
+
- **annotator_recommendations** - Smart annotator selection
|
|
210
|
+
- **annotator_dictionary** - Browse all annotators
|
|
211
|
+
- **create_job** - Create research job
|
|
212
|
+
- **job_status** - Check job progress
|
|
213
|
+
- **job_results** - Get results
|
|
214
|
+
- **pipeline_list** - List templates
|
|
215
|
+
- **user_jobs** - List user jobs
|
|
216
|
+
|
|
217
|
+
### Files Modified in Production
|
|
218
|
+
1. `/home/ubuntu/Genobank_APIs/production_api/plugins/bioos/api_bioos.py` - Added 2 endpoints
|
|
219
|
+
2. `/home/ubuntu/Genobank_APIs/production_api/plugins/bioos/opencravat_annotators_dictionary.json` - 146 annotators
|
|
220
|
+
|
|
221
|
+
## Impact & Benefits
|
|
222
|
+
|
|
223
|
+
### For Researchers
|
|
224
|
+
- **Context-aware analysis**: Claude API selects the right annotators automatically
|
|
225
|
+
- **146 annotators available**: Complete OpenCRAVAT catalog
|
|
226
|
+
- **Clinical relevance**: Phenotype-driven recommendations
|
|
227
|
+
- **Time savings**: No manual annotator selection
|
|
228
|
+
|
|
229
|
+
### For Developers
|
|
230
|
+
- **REST API access**: Programmatic annotator recommendations
|
|
231
|
+
- **Natural language processing**: Map user intent → annotators
|
|
232
|
+
- **Complete metadata**: Citations, versions, descriptions
|
|
233
|
+
- **Educational**: Learn what each annotator does
|
|
234
|
+
|
|
235
|
+
### For Claude API
|
|
236
|
+
- **Intelligent selection**: Recommend annotators based on phenotype/analysis type
|
|
237
|
+
- **Quick reference**: Browse 146 annotators instantly
|
|
238
|
+
- **Flexible queries**: By category, name, phenotype, or analysis type
|
|
239
|
+
- **Up-to-date**: Versions and citations included
|
|
240
|
+
|
|
241
|
+
## Example Workflows
|
|
242
|
+
|
|
243
|
+
### Cancer Analysis
|
|
244
|
+
```bash
|
|
245
|
+
# User creates job
|
|
246
|
+
biofs job create "Find pathogenic variants in cancer genes" tumor.vcf
|
|
247
|
+
|
|
248
|
+
# Claude API queries
|
|
249
|
+
GET /api_bioos/annotator_recommendations?phenotype=cancer
|
|
250
|
+
|
|
251
|
+
# Claude receives
|
|
252
|
+
{
|
|
253
|
+
"recommended_annotators": [
|
|
254
|
+
"clinvar", "cosmic", "cancer_genome_interpreter",
|
|
255
|
+
"cancer_hotspots", "civic", "oncokb", "chasmplus",
|
|
256
|
+
"gnomad", "alphamissense", "revel"
|
|
257
|
+
]
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
# Job created with these annotators
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Rare Disease Analysis
|
|
264
|
+
```bash
|
|
265
|
+
# User creates job
|
|
266
|
+
biofs job create "Analyze for rare Mendelian disease" proband.vcf
|
|
267
|
+
|
|
268
|
+
# Claude API queries
|
|
269
|
+
GET /api_bioos/annotator_recommendations?phenotype=rare_disease
|
|
270
|
+
|
|
271
|
+
# Claude receives comprehensive rare disease panel
|
|
272
|
+
{
|
|
273
|
+
"recommended_annotators": [
|
|
274
|
+
"clinvar", "clinvar_acmg", "omim", "hpo",
|
|
275
|
+
"gnomad", "alphamissense", "cadd",
|
|
276
|
+
"sift", "polyphen2", "spliceai"
|
|
277
|
+
]
|
|
278
|
+
}
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
### Splicing Analysis
|
|
282
|
+
```bash
|
|
283
|
+
# User creates job
|
|
284
|
+
biofs job create "Find splice site variants" patient.vcf
|
|
285
|
+
|
|
286
|
+
# Claude API queries
|
|
287
|
+
GET /api_bioos/annotator_recommendations?analysis_type=splicing
|
|
288
|
+
|
|
289
|
+
# Focused splicing panel returned
|
|
290
|
+
{
|
|
291
|
+
"recommended_annotators": [
|
|
292
|
+
"clinvar", "spliceai", "dbscsnv", "gnomad"
|
|
293
|
+
]
|
|
294
|
+
}
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
## Version History
|
|
298
|
+
|
|
299
|
+
- **v1.2.7** (Oct 7, 2025): Added OpenCRAVAT annotator intelligence
|
|
300
|
+
- **v1.2.6** (Oct 5, 2025): Added BioOS job management
|
|
301
|
+
- **v1.2.4** (Sep 2025): Initial BioIP tokenization support
|
|
302
|
+
|
|
303
|
+
## Support
|
|
304
|
+
|
|
305
|
+
- **npm Package**: https://www.npmjs.com/package/@genobank/biofs
|
|
306
|
+
- **Installation Guide**: See `INSTALL_V1.2.7_ON_MAC.md`
|
|
307
|
+
- **API Documentation**: See `ANNOTATOR_RECOMMENDATIONS_API.md`
|
|
308
|
+
- **GitHub**: https://github.com/Genobank/genobank-cli
|
|
309
|
+
- **Support**: support@genobank.io
|
|
310
|
+
|
|
311
|
+
---
|
|
312
|
+
|
|
313
|
+
**Package**: @genobank/biofs@1.2.7
|
|
314
|
+
**Published**: October 7, 2025
|
|
315
|
+
**Status**: ✅ Live on npm registry
|
|
316
|
+
**Total Annotators**: 146
|
|
317
|
+
**API Endpoints**: 7 (5 from v1.2.6 + 2 new in v1.2.7)
|