react-msaview-cli 5.10.0 → 6.1.0

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.
Files changed (2) hide show
  1. package/README.md +26 -5
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -94,16 +94,33 @@ is byte-for-byte compatible with the `interproscan` command.
94
94
 
95
95
  #### Options
96
96
 
97
- | Option | Description | Default |
98
- | --------------------- | -------------------------- | ------------- |
99
- | `-o, --output <file>` | Output GFF file path | `domains.gff` |
100
- | `--database <name>` | InterPro member db to read | `pfam` |
97
+ | Option | Description | Default |
98
+ | --------------------- | --------------------------------- | ------------- |
99
+ | `-o, --output <file>` | Output GFF file path | `domains.gff` |
100
+ | `--database <name>` | InterPro member db to read | `pfam` |
101
+ | `--no-cache` | Re-fetch, ignoring the disk cache | off |
101
102
 
102
103
  ```bash
103
104
  react-msaview-cli interpro accessions.tsv -o domains.gff
104
105
  react-msaview-cli interpro accessions.tsv -o domains.gff --database cdd
105
106
  ```
106
107
 
108
+ #### Caching
109
+
110
+ The InterPro API serves one protein per request — there is no batch endpoint —
111
+ so the request count is fixed at one per distinct accession. To keep that from
112
+ being paid twice, every response is cached on disk under
113
+ `$XDG_CACHE_HOME/react-msaview-cli/interpro` (override with
114
+ `REACT_MSAVIEW_CACHE`), keyed by InterPro release so a new release misses
115
+ cleanly rather than serving coordinates computed against the old one. Proteins
116
+ with no matches are cached too, so they are not re-fetched every run.
117
+
118
+ A re-run of the same dataset therefore makes one request — the release lookup —
119
+ and answers the rest from disk. That also makes a failed run resumable: retries
120
+ are automatic with backoff, and if the API is still unreachable the accessions
121
+ already fetched stay cached, so re-running picks up where it stopped instead of
122
+ asking EBI for all of them again.
123
+
107
124
  ### genestructure
108
125
 
109
126
  Build a **gene-structure GFF** for a coding-sequence alignment from a RefSeq
@@ -276,9 +293,13 @@ seq2 InterProScan protein_match 5 120 . . . Name=PF00001;signature_desc=7tm_1;de
276
293
  After generating the GFF file, you can load it in react-msaview:
277
294
 
278
295
  - Open your MSA file in react-msaview
279
- - Go to **Menu > Open domains...** and select the generated GFF file
296
+ - Select the generated GFF file in the import form's **Annotation GFF file or
297
+ URL** field
280
298
  - Domains appear as colored boxes on the alignment
281
299
 
300
+ The **Annotations > Open InterProScan results...** menu item takes InterProScan
301
+ JSON rather than GFF, so use the import form for the file generated above.
302
+
282
303
  In the React component, pass it inline as the `gff` prop (see the "Protein
283
304
  domains" example in `packages/examples`):
284
305
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-msaview-cli",
3
- "version": "5.10.0",
3
+ "version": "6.1.0",
4
4
  "license": "MIT",
5
5
  "type": "module",
6
6
  "repository": {
@@ -28,8 +28,8 @@
28
28
  "mobx-react": "^10.0.0",
29
29
  "react": "^19.2.8",
30
30
  "react-dom": "^19.2.8",
31
- "msa-parsers": "5.10.0",
32
- "react-msaview": "5.10.0"
31
+ "msa-parsers": "6.1.0",
32
+ "react-msaview": "6.1.0"
33
33
  },
34
34
  "scripts": {
35
35
  "clean": "node --eval \"fs.rmSync('dist',{recursive:true,force:true})\" --input-type=module",