@genobank/biofs 2.4.1 → 2.5.1
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/CHANGELOG.md +2 -0
- package/LICENSE +37 -0
- package/README.md +2 -1
- package/bin/biofs.js +2 -1
- package/contracts/ClaraJobNFT.sol +101 -0
- package/dist/commands/agent/health.js +1 -1
- package/dist/commands/agent/health.js.map +1 -1
- package/dist/commands/agent/list.d.ts +14 -0
- package/dist/commands/agent/list.d.ts.map +1 -0
- package/dist/commands/agent/list.js +101 -0
- package/dist/commands/agent/list.js.map +1 -0
- package/dist/commands/agent/register.d.ts +18 -0
- package/dist/commands/agent/register.d.ts.map +1 -0
- package/dist/commands/agent/register.js +120 -0
- package/dist/commands/agent/register.js.map +1 -0
- package/dist/commands/agent/status.d.ts +14 -0
- package/dist/commands/agent/status.d.ts.map +1 -0
- package/dist/commands/agent/status.js +151 -0
- package/dist/commands/agent/status.js.map +1 -0
- package/dist/commands/annotate/status.d.ts +11 -0
- package/dist/commands/annotate/status.d.ts.map +1 -0
- package/dist/commands/annotate/status.js +123 -0
- package/dist/commands/annotate/status.js.map +1 -0
- package/dist/commands/annotate/submit.d.ts +23 -0
- package/dist/commands/annotate/submit.d.ts.map +1 -0
- package/dist/commands/annotate/submit.js +296 -0
- package/dist/commands/annotate/submit.js.map +1 -0
- package/dist/commands/family-status.d.ts +12 -0
- package/dist/commands/family-status.d.ts.map +1 -0
- package/dist/commands/family-status.js +220 -0
- package/dist/commands/family-status.js.map +1 -0
- package/dist/commands/job/status.d.ts +1 -0
- package/dist/commands/job/status.d.ts.map +1 -1
- package/dist/commands/job/status.js.map +1 -1
- package/dist/commands/link-clara.d.ts +20 -0
- package/dist/commands/link-clara.d.ts.map +1 -0
- package/dist/commands/link-clara.js +234 -0
- package/dist/commands/link-clara.js.map +1 -0
- package/dist/commands/mount-remote.d.ts +1 -1
- package/dist/commands/mount-remote.js +1 -1
- package/dist/commands/payment/balance.d.ts +12 -0
- package/dist/commands/payment/balance.d.ts.map +1 -0
- package/dist/commands/payment/balance.js +101 -0
- package/dist/commands/payment/balance.js.map +1 -0
- package/dist/commands/payment/faucet.d.ts +11 -0
- package/dist/commands/payment/faucet.d.ts.map +1 -0
- package/dist/commands/payment/faucet.js +92 -0
- package/dist/commands/payment/faucet.js.map +1 -0
- package/dist/commands/payment/history.d.ts +27 -0
- package/dist/commands/payment/history.d.ts.map +1 -0
- package/dist/commands/payment/history.js +162 -0
- package/dist/commands/payment/history.js.map +1 -0
- package/dist/commands/payment/pricing.d.ts +12 -0
- package/dist/commands/payment/pricing.d.ts.map +1 -0
- package/dist/commands/payment/pricing.js +65 -0
- package/dist/commands/payment/pricing.js.map +1 -0
- package/dist/commands/payment/setup.d.ts +25 -0
- package/dist/commands/payment/setup.d.ts.map +1 -0
- package/dist/commands/payment/setup.js +155 -0
- package/dist/commands/payment/setup.js.map +1 -0
- package/dist/commands/tokenize-biosample.d.ts +19 -0
- package/dist/commands/tokenize-biosample.d.ts.map +1 -0
- package/dist/commands/tokenize-biosample.js +253 -0
- package/dist/commands/tokenize-biosample.js.map +1 -0
- package/dist/index.js +281 -13
- package/dist/index.js.map +1 -1
- package/dist/lib/api/bionft-client.d.ts +35 -7
- package/dist/lib/api/bionft-client.d.ts.map +1 -1
- package/dist/lib/api/bionft-client.js +106 -16
- package/dist/lib/api/bionft-client.js.map +1 -1
- package/dist/lib/kite/agent.d.ts +85 -0
- package/dist/lib/kite/agent.d.ts.map +1 -0
- package/dist/lib/kite/agent.js +332 -0
- package/dist/lib/kite/agent.js.map +1 -0
- package/dist/lib/kite/index.d.ts +9 -0
- package/dist/lib/kite/index.d.ts.map +1 -0
- package/dist/lib/kite/index.js +25 -0
- package/dist/lib/kite/index.js.map +1 -0
- package/dist/lib/kite/passport.d.ts +69 -0
- package/dist/lib/kite/passport.d.ts.map +1 -0
- package/dist/lib/kite/passport.js +312 -0
- package/dist/lib/kite/passport.js.map +1 -0
- package/dist/lib/x402/client.d.ts +78 -0
- package/dist/lib/x402/client.d.ts.map +1 -0
- package/dist/lib/x402/client.js +298 -0
- package/dist/lib/x402/client.js.map +1 -0
- package/dist/lib/x402/index.d.ts +9 -0
- package/dist/lib/x402/index.d.ts.map +1 -0
- package/dist/lib/x402/index.js +37 -0
- package/dist/lib/x402/index.js.map +1 -0
- package/dist/lib/x402/middleware.d.ts +37 -0
- package/dist/lib/x402/middleware.d.ts.map +1 -0
- package/dist/lib/x402/middleware.js +220 -0
- package/dist/lib/x402/middleware.js.map +1 -0
- package/dist/types/kite.d.ts +157 -0
- package/dist/types/kite.d.ts.map +1 -0
- package/dist/types/kite.js +107 -0
- package/dist/types/kite.js.map +1 -0
- package/dist/types/x402.d.ts +78 -0
- package/dist/types/x402.d.ts.map +1 -0
- package/dist/types/x402.js +79 -0
- package/dist/types/x402.js.map +1 -0
- package/docs/AI_AGENT_MCP_MANUAL.md +1029 -0
- package/docs/USER_MANUAL.md +603 -0
- package/docs/technical-details.html +555 -0
- package/lib/bionfs-client.js +2 -0
- package/lib/consent-manager.js +2 -0
- package/lib/consent-prompt.js +2 -0
- package/package.json +9 -3
- package/presentation/biofs-x402-kite-presentation.html +813 -0
- package/scripts/build_annotator_dictionary.py +1 -0
- package/scripts/deploy-clara-nft.js +37 -0
- package/test-complete-flow.sh +1 -1
- package/test.vcf +1 -0
- package/test_23andme.txt +1 -0
- package/ADMIN_REGISTER_LAB.md +0 -252
- package/ANNOTATOR_RECOMMENDATIONS_API.md +0 -490
- package/BIOFS_QUICK_START.md +0 -200
- package/BIOFS_TOKENIZE_COMPLETE.md +0 -541
- package/BIOFS_V1.2.7_PUBLISHED.md +0 -317
- package/BIOFS_V1.2.9_FIXES.md +0 -306
- package/BIOFS_V1.3.0_DIRECT_GRANT.md +0 -381
- package/BIOFS_V1.3.1_GRANTED_FILES.md +0 -328
- package/BIONFS_DEPLOYMENT_GUIDE.md +0 -408
- package/BIONFS_MOUNT_INTEGRATION_PLAN.md +0 -415
- package/BIONFS_PROTOCOL_SPECIFICATION.md +0 -688
- package/BIONFS_SEQUENTIAS_INTEGRATION.md +0 -457
- package/BIONFT_GATED_REMOTE_MOUNTING.md +0 -1260
- package/BIONFT_NFS_PROTOCOL_ARCHITECTURE.md +0 -583
- package/BIOOS_CLI_IMPLEMENTATION_COMPLETE.md +0 -422
- package/BIOOS_JOB_MANAGEMENT.md +0 -681
- package/BUGFIX_V2.1.3.md +0 -72
- package/CHANGELOG_V2.1.0.md +0 -386
- package/CHANGELOG_V2.2.0.md +0 -284
- package/ENHANCEMENT_DOCUMENTATION.md +0 -218
- package/GDPR_BIONFS_CONSENT_ARCHITECTURE.md +0 -798
- package/GDPR_BIONFS_IMPLEMENTATION_STATUS.md +0 -462
- package/INSTALL_V1.2.7_ON_MAC.md +0 -306
- package/LABNFT_BIOFS_INTEGRATION.md +0 -396
- package/OPENCRAVAT_ANNOTATORS_REFERENCE.md +0 -340
- package/OPENCRAVAT_ANNOTATOR_INTELLIGENCE_COMPLETE.md +0 -479
- package/QUICK_START_V2.1.0.md +0 -116
- package/RELEASE_SUMMARY_V1.2.7.md +0 -479
- package/RELEASE_SUMMARY_V1.3.0.md +0 -324
- package/SEQUENTIAS_PROTOCOL_ARCHITECTURE.md +0 -880
- package/SEQUENTIA_MIGRATION_GUIDE.md +0 -337
- package/SESSION_SUMMARY_DIRECT_GRANT.md +0 -321
- package/ULTRATHINK_BIONFS_COMPLETE.md +0 -458
- package/WEB3FUSE_LICENSE_TOKEN_ANALYSIS.md +0 -494
- package/WHERE_PERMISSIONS_LIVE.md +0 -165
- package/config.json +0 -21
- package/opencravat_annotators_dictionary.json +0 -2356
- package/package.json.working.v1.9.2.20251105_023952 +0 -48
|
@@ -1,479 +0,0 @@
|
|
|
1
|
-
# BioFS v1.2.7 Release Summary - OpenCRAVAT Annotator Intelligence
|
|
2
|
-
|
|
3
|
-
## 🎉 Successfully Released!
|
|
4
|
-
|
|
5
|
-
**Package**: `@genobank/biofs@1.2.7`
|
|
6
|
-
**Status**: ✅ Published to npm registry
|
|
7
|
-
**Release Date**: October 7, 2025
|
|
8
|
-
**npm URL**: https://www.npmjs.com/package/@genobank/biofs
|
|
9
|
-
|
|
10
|
-
## Installation for Dra. Claudia (Mac)
|
|
11
|
-
|
|
12
|
-
### Quick Install from npm
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
# Install from npm registry (easiest method)
|
|
16
|
-
npm install -g @genobank/biofs@1.2.7
|
|
17
|
-
|
|
18
|
-
# Verify installation
|
|
19
|
-
biofs --version # Should show: 1.2.7
|
|
20
|
-
|
|
21
|
-
# Check authentication (should already be logged in)
|
|
22
|
-
biofs whoami # Should show: 0xb3c3a584491b8ca4df45116a1e250098a0d6192d
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### Alternative: Manual Install from Server
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
# Download tarball from server
|
|
29
|
-
scp ubuntu@44.220.145.233:/home/ubuntu/genobank-cli/genobank-biofs-1.2.7.tgz ~/Downloads/
|
|
30
|
-
|
|
31
|
-
# Install globally
|
|
32
|
-
npm install -g ~/Downloads/genobank-biofs-1.2.7.tgz
|
|
33
|
-
|
|
34
|
-
# Verify
|
|
35
|
-
biofs --version
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## What's New
|
|
39
|
-
|
|
40
|
-
### 🧬 OpenCRAVAT Annotator Intelligence
|
|
41
|
-
|
|
42
|
-
The CLI now has access to a complete dictionary of **146 OpenCRAVAT annotators** with intelligent recommendations based on clinical context.
|
|
43
|
-
|
|
44
|
-
#### Features Implemented:
|
|
45
|
-
|
|
46
|
-
1. **Complete Annotator Dictionary**
|
|
47
|
-
- 146 annotators catalogued
|
|
48
|
-
- 12 categories (clinical_significance, cancer, population_frequency, etc.)
|
|
49
|
-
- Complete metadata (versions, citations, developers, descriptions)
|
|
50
|
-
|
|
51
|
-
2. **Phenotype-Based Recommendations** (7 types)
|
|
52
|
-
- `cancer` → clinvar, cosmic, cancer_genome_interpreter, civic, oncokb, chasmplus, gnomad, alphamissense, revel
|
|
53
|
-
- `rare_disease` → clinvar, clinvar_acmg, omim, hpo, gnomad, alphamissense, cadd, sift, polyphen2, spliceai
|
|
54
|
-
- `cardiovascular` → clinvar, cardioboost, cvdkp, gnomad, alphamissense, sift, polyphen2
|
|
55
|
-
- `hereditary_cancer` → clinvar, brca1_func_assay, cgc, cosmic, gnomad, alphamissense, revel
|
|
56
|
-
- `pharmacogenomics` → pharmgkb, dgi, clinvar, gnomad
|
|
57
|
-
- `autism` → clinvar, omim, hpo, gnomad, denovo, alphamissense, cadd
|
|
58
|
-
- `developmental_delay` → clinvar, omim, hpo, gnomad, denovo, alphamissense, spliceai
|
|
59
|
-
|
|
60
|
-
3. **Analysis-Type Recommendations** (4 types)
|
|
61
|
-
- `rare_coding` → clinvar, gnomad, alphamissense, revel, cadd, sift, polyphen2, vest
|
|
62
|
-
- `splicing` → clinvar, spliceai, dbscsnv, gnomad
|
|
63
|
-
- `regulatory` → encode_tfbs, ensembl_regulatory_build, regulomedb, vista_enhancer, gnomad
|
|
64
|
-
- `de_novo` → clinvar, denovo, gnomad, alphamissense, cadd
|
|
65
|
-
|
|
66
|
-
4. **API Endpoints for Claude Integration**
|
|
67
|
-
- `GET /api_bioos/annotator_recommendations?phenotype={type}` - Get smart recommendations
|
|
68
|
-
- `GET /api_bioos/annotator_recommendations?analysis_type={type}` - Analysis-specific
|
|
69
|
-
- `GET /api_bioos/annotator_dictionary?category={cat}` - Browse by category
|
|
70
|
-
- `GET /api_bioos/annotator_dictionary?name={name}` - Look up specific annotator
|
|
71
|
-
|
|
72
|
-
#### How It Works:
|
|
73
|
-
|
|
74
|
-
When you create a job like:
|
|
75
|
-
```bash
|
|
76
|
-
biofs job create "Annotate VCF with rare coding variants" sample.vcf --pipeline vcf_annotation
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
Claude API now:
|
|
80
|
-
1. Parses your prompt: "rare coding variants"
|
|
81
|
-
2. Queries: `GET /api_bioos/annotator_recommendations?analysis_type=rare_coding`
|
|
82
|
-
3. Receives: `[clinvar, gnomad, alphamissense, revel, cadd, sift, polyphen2, vest]`
|
|
83
|
-
4. Creates job with these annotators automatically
|
|
84
|
-
|
|
85
|
-
## Testing the New Features
|
|
86
|
-
|
|
87
|
-
### Test 1: Check Version and Authentication
|
|
88
|
-
|
|
89
|
-
```bash
|
|
90
|
-
# Verify installation
|
|
91
|
-
biofs --version # Should show: 1.2.7
|
|
92
|
-
|
|
93
|
-
# Check authentication (you're already logged in)
|
|
94
|
-
biofs whoami # Should show: 0xb3c3a584491b8ca4df45116a1e250098a0d6192d
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### Test 2: Test Annotator Recommendations
|
|
98
|
-
|
|
99
|
-
```bash
|
|
100
|
-
# Get cancer-specific annotators
|
|
101
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=cancer"
|
|
102
|
-
|
|
103
|
-
# Expected output:
|
|
104
|
-
# {
|
|
105
|
-
# "status": "Success",
|
|
106
|
-
# "status_details": {
|
|
107
|
-
# "data": {
|
|
108
|
-
# "phenotype": "cancer",
|
|
109
|
-
# "description": "Cancer-related analysis",
|
|
110
|
-
# "recommended_annotators": [
|
|
111
|
-
# "clinvar", "cosmic", "cancer_genome_interpreter",
|
|
112
|
-
# "cancer_hotspots", "civic", "oncokb", "chasmplus",
|
|
113
|
-
# "gnomad", "alphamissense", "revel"
|
|
114
|
-
# ]
|
|
115
|
-
# }
|
|
116
|
-
# }
|
|
117
|
-
# }
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
```bash
|
|
121
|
-
# Get rare disease annotators
|
|
122
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=rare_disease"
|
|
123
|
-
|
|
124
|
-
# Get splicing-specific annotators
|
|
125
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?analysis_type=splicing"
|
|
126
|
-
|
|
127
|
-
# Browse all 146 annotators
|
|
128
|
-
curl "https://genobank.app/api_bioos/annotator_dictionary"
|
|
129
|
-
|
|
130
|
-
# Look up AlphaMissense
|
|
131
|
-
curl "https://genobank.app/api_bioos/annotator_dictionary?name=alphamissense"
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Test 3: List Pipeline Templates
|
|
135
|
-
|
|
136
|
-
```bash
|
|
137
|
-
biofs job pipelines
|
|
138
|
-
|
|
139
|
-
# Expected output:
|
|
140
|
-
# 🔧 Available Pipeline Templates:
|
|
141
|
-
#
|
|
142
|
-
# ┌────────────────────┬──────────────────────────────┬──────────────────────┐
|
|
143
|
-
# │ Template ID │ Name │ Description │
|
|
144
|
-
# ├────────────────────┼──────────────────────────────┼──────────────────────┤
|
|
145
|
-
# │ fastq_to_report │ FASTQ to Clinical Report │ Process FASTQ → VCF…│
|
|
146
|
-
# │ vcf_annotation │ VCF Annotation │ Annotate VCF with… │
|
|
147
|
-
# │ vcf_alphagenome │ VCF with AlphaMissense Scor… │ Annotate VCF and… │
|
|
148
|
-
# └────────────────────┴──────────────────────────────┴──────────────────────┘
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
### Test 4: List Your Files
|
|
152
|
-
|
|
153
|
-
```bash
|
|
154
|
-
biofs files
|
|
155
|
-
|
|
156
|
-
# This should show all Dra. Claudia's files from S3, IPFS, and Story Protocol
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
### Test 5: Create a Test Job (If You Have a VCF)
|
|
160
|
-
|
|
161
|
-
```bash
|
|
162
|
-
# Natural language - Claude picks the right annotators
|
|
163
|
-
biofs job create "Find pathogenic variants in cancer genes" your_file.vcf
|
|
164
|
-
|
|
165
|
-
# OR with pipeline template
|
|
166
|
-
biofs job create "Annotate with rare coding variants" your_file.vcf --pipeline vcf_annotation
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
## Files Created/Modified
|
|
170
|
-
|
|
171
|
-
### On Server (`/home/ubuntu/genobank-cli/`)
|
|
172
|
-
|
|
173
|
-
**New Files:**
|
|
174
|
-
1. `opencravat_annotators_dictionary.json` - Complete dictionary of 146 annotators
|
|
175
|
-
2. `OPENCRAVAT_ANNOTATORS_REFERENCE.md` - Human-readable reference
|
|
176
|
-
3. `ANNOTATOR_RECOMMENDATIONS_API.md` - API documentation
|
|
177
|
-
4. `scripts/build_annotator_dictionary.py` - Dictionary builder script
|
|
178
|
-
5. `OPENCRAVAT_ANNOTATOR_INTELLIGENCE_COMPLETE.md` - Implementation guide
|
|
179
|
-
6. `BIOFS_V1.2.7_PUBLISHED.md` - Publishing documentation
|
|
180
|
-
7. `INSTALL_V1.2.7_ON_MAC.md` - Installation guide (renamed from v1.2.6)
|
|
181
|
-
8. `genobank-biofs-1.2.7.tgz` - Manual installation tarball
|
|
182
|
-
|
|
183
|
-
**Modified Files:**
|
|
184
|
-
9. `package.json` - Version bumped to 1.2.7
|
|
185
|
-
10. `src/index.ts` - Version bumped to 1.2.7
|
|
186
|
-
|
|
187
|
-
### On Production API
|
|
188
|
-
|
|
189
|
-
**Files Modified:**
|
|
190
|
-
1. `/home/ubuntu/Genobank_APIs/production_api/plugins/bioos/api_bioos.py`
|
|
191
|
-
- Added `annotator_recommendations()` endpoint
|
|
192
|
-
- Added `annotator_dictionary()` endpoint
|
|
193
|
-
- Updated index endpoint with new endpoints
|
|
194
|
-
|
|
195
|
-
**Files Added:**
|
|
196
|
-
2. `/home/ubuntu/Genobank_APIs/production_api/plugins/bioos/opencravat_annotators_dictionary.json`
|
|
197
|
-
- Complete dictionary for API to use
|
|
198
|
-
|
|
199
|
-
## API Endpoints Added
|
|
200
|
-
|
|
201
|
-
### 1. Annotator Recommendations
|
|
202
|
-
|
|
203
|
-
```bash
|
|
204
|
-
GET /api_bioos/annotator_recommendations
|
|
205
|
-
GET /api_bioos/annotator_recommendations?phenotype={type}
|
|
206
|
-
GET /api_bioos/annotator_recommendations?analysis_type={type}
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
**Example:**
|
|
210
|
-
```bash
|
|
211
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=cancer"
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
**Response:**
|
|
215
|
-
```json
|
|
216
|
-
{
|
|
217
|
-
"status": "Success",
|
|
218
|
-
"status_details": {
|
|
219
|
-
"data": {
|
|
220
|
-
"phenotype": "cancer",
|
|
221
|
-
"description": "Cancer-related analysis",
|
|
222
|
-
"recommended_annotators": [
|
|
223
|
-
"clinvar", "cosmic", "cancer_genome_interpreter",
|
|
224
|
-
"cancer_hotspots", "civic", "oncokb", "chasmplus",
|
|
225
|
-
"gnomad", "alphamissense", "revel"
|
|
226
|
-
],
|
|
227
|
-
"annotator_details": [
|
|
228
|
-
{
|
|
229
|
-
"name": "clinvar",
|
|
230
|
-
"title": "ClinVar",
|
|
231
|
-
"description": "ClinVar is an archive of reports...",
|
|
232
|
-
"version": "2025.09.01",
|
|
233
|
-
"developer": "NCBI"
|
|
234
|
-
}
|
|
235
|
-
]
|
|
236
|
-
}
|
|
237
|
-
}
|
|
238
|
-
}
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
### 2. Annotator Dictionary
|
|
242
|
-
|
|
243
|
-
```bash
|
|
244
|
-
GET /api_bioos/annotator_dictionary
|
|
245
|
-
GET /api_bioos/annotator_dictionary?category={cat}
|
|
246
|
-
GET /api_bioos/annotator_dictionary?name={name}
|
|
247
|
-
```
|
|
248
|
-
|
|
249
|
-
**Example:**
|
|
250
|
-
```bash
|
|
251
|
-
curl "https://genobank.app/api_bioos/annotator_dictionary?name=alphamissense"
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
**Response:**
|
|
255
|
-
```json
|
|
256
|
-
{
|
|
257
|
-
"status": "Success",
|
|
258
|
-
"status_details": {
|
|
259
|
-
"data": {
|
|
260
|
-
"name": "alphamissense",
|
|
261
|
-
"title": "AlphaMissense",
|
|
262
|
-
"description": "Variant pathogenicity scores from AlphaMissense",
|
|
263
|
-
"tags": ["variant effect prediction", "variants"],
|
|
264
|
-
"level": "variant",
|
|
265
|
-
"version": "1.1.1",
|
|
266
|
-
"developer": "Google DeepMind",
|
|
267
|
-
"citation": "Cheng, Jun, et al...",
|
|
268
|
-
"website": "https://github.com/google-deepmind/alphamissense"
|
|
269
|
-
}
|
|
270
|
-
}
|
|
271
|
-
}
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
## Natural Language Mapping
|
|
275
|
-
|
|
276
|
-
Claude API now maps user prompts to the right annotators:
|
|
277
|
-
|
|
278
|
-
| User Says | Claude Maps To | Annotators Selected |
|
|
279
|
-
|-----------|----------------|---------------------|
|
|
280
|
-
| "find cancer variants" | `phenotype=cancer` | cosmic, civic, oncokb, chasmplus |
|
|
281
|
-
| "rare coding variants" | `analysis_type=rare_coding` | gnomad, alphamissense, revel, cadd |
|
|
282
|
-
| "splice site mutations" | `analysis_type=splicing` | spliceai, dbscsnv |
|
|
283
|
-
| "autism spectrum disorder" | `phenotype=autism` | clinvar, omim, hpo, denovo |
|
|
284
|
-
| "BRCA1 hereditary cancer" | `phenotype=hereditary_cancer` | clinvar, brca1_func_assay, cosmic |
|
|
285
|
-
|
|
286
|
-
## Workflow Examples
|
|
287
|
-
|
|
288
|
-
### Example 1: Cancer Analysis
|
|
289
|
-
|
|
290
|
-
```bash
|
|
291
|
-
# User creates job
|
|
292
|
-
biofs job create "Find pathogenic variants in cancer genes" tumor.vcf
|
|
293
|
-
|
|
294
|
-
# Behind the scenes:
|
|
295
|
-
# 1. Claude parses: "cancer genes" → phenotype=cancer
|
|
296
|
-
# 2. Claude queries: GET /api_bioos/annotator_recommendations?phenotype=cancer
|
|
297
|
-
# 3. Claude receives: [clinvar, cosmic, cancer_genome_interpreter, civic, oncokb, gnomad, alphamissense]
|
|
298
|
-
# 4. Job created with these annotators
|
|
299
|
-
```
|
|
300
|
-
|
|
301
|
-
### Example 2: Rare Disease Analysis
|
|
302
|
-
|
|
303
|
-
```bash
|
|
304
|
-
# User creates job
|
|
305
|
-
biofs job create "Analyze for rare Mendelian disease" proband.vcf
|
|
306
|
-
|
|
307
|
-
# Behind the scenes:
|
|
308
|
-
# 1. Claude parses: "rare Mendelian disease" → phenotype=rare_disease
|
|
309
|
-
# 2. Claude queries: GET /api_bioos/annotator_recommendations?phenotype=rare_disease
|
|
310
|
-
# 3. Claude receives: [clinvar, clinvar_acmg, omim, hpo, gnomad, alphamissense, cadd, sift, polyphen2, spliceai]
|
|
311
|
-
# 4. Comprehensive rare disease panel used
|
|
312
|
-
```
|
|
313
|
-
|
|
314
|
-
### Example 3: Splicing Analysis
|
|
315
|
-
|
|
316
|
-
```bash
|
|
317
|
-
# User creates job
|
|
318
|
-
biofs job create "Find splice site variants" patient.vcf
|
|
319
|
-
|
|
320
|
-
# Behind the scenes:
|
|
321
|
-
# 1. Claude parses: "splice site" → analysis_type=splicing
|
|
322
|
-
# 2. Claude queries: GET /api_bioos/annotator_recommendations?analysis_type=splicing
|
|
323
|
-
# 3. Claude receives: [clinvar, spliceai, dbscsnv, gnomad]
|
|
324
|
-
# 4. Focused splicing analysis created
|
|
325
|
-
```
|
|
326
|
-
|
|
327
|
-
## Documentation Included
|
|
328
|
-
|
|
329
|
-
The package includes comprehensive documentation:
|
|
330
|
-
|
|
331
|
-
1. **OPENCRAVAT_ANNOTATORS_REFERENCE.md**
|
|
332
|
-
- All 146 annotators categorized
|
|
333
|
-
- Quick reference by category
|
|
334
|
-
- Phenotype recommendations
|
|
335
|
-
- Analysis type recommendations
|
|
336
|
-
|
|
337
|
-
2. **ANNOTATOR_RECOMMENDATIONS_API.md**
|
|
338
|
-
- API endpoint documentation
|
|
339
|
-
- Usage examples
|
|
340
|
-
- Claude API integration guide
|
|
341
|
-
- Natural language mapping table
|
|
342
|
-
|
|
343
|
-
3. **OPENCRAVAT_ANNOTATOR_INTELLIGENCE_COMPLETE.md**
|
|
344
|
-
- Complete implementation summary
|
|
345
|
-
- Testing results
|
|
346
|
-
- Usage guide
|
|
347
|
-
- Maintenance instructions
|
|
348
|
-
|
|
349
|
-
4. **BIOOS_JOB_MANAGEMENT.md**
|
|
350
|
-
- Job management guide (from v1.2.6)
|
|
351
|
-
- Pipeline templates
|
|
352
|
-
- Natural language prompts
|
|
353
|
-
|
|
354
|
-
5. **INSTALL_V1.2.7_ON_MAC.md**
|
|
355
|
-
- Installation instructions
|
|
356
|
-
- Testing guide
|
|
357
|
-
- Troubleshooting
|
|
358
|
-
|
|
359
|
-
## Troubleshooting
|
|
360
|
-
|
|
361
|
-
### If Version Shows 1.2.4 or 1.2.6
|
|
362
|
-
|
|
363
|
-
```bash
|
|
364
|
-
# Uninstall old version
|
|
365
|
-
npm uninstall -g @genobank/biofs
|
|
366
|
-
|
|
367
|
-
# Install new version
|
|
368
|
-
npm install -g @genobank/biofs@1.2.7
|
|
369
|
-
|
|
370
|
-
# Verify
|
|
371
|
-
biofs --version # Should show: 1.2.7
|
|
372
|
-
```
|
|
373
|
-
|
|
374
|
-
### Permission Errors
|
|
375
|
-
|
|
376
|
-
```bash
|
|
377
|
-
# Use sudo on Mac
|
|
378
|
-
sudo npm install -g @genobank/biofs@1.2.7
|
|
379
|
-
```
|
|
380
|
-
|
|
381
|
-
### Clear Cache if Needed
|
|
382
|
-
|
|
383
|
-
```bash
|
|
384
|
-
npm cache clean --force
|
|
385
|
-
npm install -g @genobank/biofs@1.2.7
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
## Technical Details
|
|
389
|
-
|
|
390
|
-
### Dictionary Builder
|
|
391
|
-
|
|
392
|
-
**Script**: `/home/ubuntu/genobank-cli/scripts/build_annotator_dictionary.py`
|
|
393
|
-
|
|
394
|
-
**What it does**:
|
|
395
|
-
1. Scans `/apps/opencravat_modules/annotators/` directory
|
|
396
|
-
2. Parses YAML metadata from each annotator (`.yml` files)
|
|
397
|
-
3. Categorizes by tags and functionality
|
|
398
|
-
4. Builds phenotype and analysis type recommendations
|
|
399
|
-
5. Outputs JSON dictionary and Markdown reference
|
|
400
|
-
|
|
401
|
-
**To update dictionary** (when new annotators installed):
|
|
402
|
-
```bash
|
|
403
|
-
python3.12 /home/ubuntu/genobank-cli/scripts/build_annotator_dictionary.py
|
|
404
|
-
|
|
405
|
-
# Copy to production
|
|
406
|
-
cp opencravat_annotators_dictionary.json \
|
|
407
|
-
/home/ubuntu/Genobank_APIs/production_api/plugins/bioos/
|
|
408
|
-
|
|
409
|
-
# Restart API
|
|
410
|
-
sudo systemctl restart api_genobank_prod.service
|
|
411
|
-
```
|
|
412
|
-
|
|
413
|
-
### Package Contents
|
|
414
|
-
|
|
415
|
-
- **Package Size**: 157.1 KB
|
|
416
|
-
- **Unpacked Size**: 724.9 KB
|
|
417
|
-
- **Total Files**: 193
|
|
418
|
-
- **Main Entry**: `bin/biofs.js`
|
|
419
|
-
- **TypeScript Compiled**: All `.ts` → `.js` + `.d.ts` + `.js.map`
|
|
420
|
-
|
|
421
|
-
## Service Status
|
|
422
|
-
|
|
423
|
-
### Production API
|
|
424
|
-
- **Status**: ✅ Running
|
|
425
|
-
- **Service**: `api_genobank_prod.service`
|
|
426
|
-
- **Port**: 8080
|
|
427
|
-
- **Base URL**: https://genobank.app/api_bioos/
|
|
428
|
-
|
|
429
|
-
### New Endpoints Active
|
|
430
|
-
1. ✅ `annotator_recommendations` - Smart annotator selection
|
|
431
|
-
2. ✅ `annotator_dictionary` - Browse all annotators
|
|
432
|
-
|
|
433
|
-
## What's Next
|
|
434
|
-
|
|
435
|
-
The CLI is now ready for intelligent job creation. When you say:
|
|
436
|
-
|
|
437
|
-
```bash
|
|
438
|
-
biofs job create "Find pathogenic variants in BRCA1/BRCA2 genes" sample.vcf
|
|
439
|
-
```
|
|
440
|
-
|
|
441
|
-
Claude API will:
|
|
442
|
-
1. Understand this is hereditary cancer analysis
|
|
443
|
-
2. Query the recommendations API
|
|
444
|
-
3. Select: clinvar, brca1_func_assay, cgc, cosmic, gnomad, alphamissense, revel
|
|
445
|
-
4. Create the job with the optimal annotator set
|
|
446
|
-
5. Return results with comprehensive cancer-focused annotations
|
|
447
|
-
|
|
448
|
-
## Support & Resources
|
|
449
|
-
|
|
450
|
-
- **npm Package**: https://www.npmjs.com/package/@genobank/biofs
|
|
451
|
-
- **Installation Guide**: `INSTALL_V1.2.7_ON_MAC.md`
|
|
452
|
-
- **API Documentation**: `ANNOTATOR_RECOMMENDATIONS_API.md`
|
|
453
|
-
- **Annotator Reference**: `OPENCRAVAT_ANNOTATORS_REFERENCE.md`
|
|
454
|
-
- **Support Email**: support@genobank.io
|
|
455
|
-
|
|
456
|
-
---
|
|
457
|
-
|
|
458
|
-
## Summary
|
|
459
|
-
|
|
460
|
-
✅ **Successfully published BioFS v1.2.7 to npm registry**
|
|
461
|
-
|
|
462
|
-
**Key Achievements**:
|
|
463
|
-
- 146 OpenCRAVAT annotators catalogued
|
|
464
|
-
- 7 phenotype-based recommendation sets
|
|
465
|
-
- 4 analysis-type recommendation sets
|
|
466
|
-
- 2 new API endpoints implemented and tested
|
|
467
|
-
- Complete documentation created
|
|
468
|
-
- Production API updated and running
|
|
469
|
-
- npm package published and available globally
|
|
470
|
-
|
|
471
|
-
**Installation**: `npm install -g @genobank/biofs@1.2.7`
|
|
472
|
-
|
|
473
|
-
**Status**: Ready for production use with intelligent annotator selection! 🚀
|
|
474
|
-
|
|
475
|
-
---
|
|
476
|
-
|
|
477
|
-
**Package**: @genobank/biofs@1.2.7
|
|
478
|
-
**Published**: October 7, 2025 ✅
|
|
479
|
-
**Your Credentials**: Already authenticated (0xb3c3a584491b8ca4df45116a1e250098a0d6192d)
|