@jbrowse/cli 5.0.0-beta.10 → 5.0.0-beta.13

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/README.md CHANGED
@@ -340,14 +340,14 @@ any other appearance setting (labels, mouseover, filter).
340
340
  --multiwig bundles several BigWigs into one MultiQuantitativeTrack, in place of
341
341
  the positional track argument: pass a comma-separated list of BigWig files/URLs,
342
342
  or a .json file with an array of BigWig locations or subadapter objects (each
343
- carrying its own name/color/group). With --load, local list entries are copied
344
- like any other track file.
343
+ with its own name/color/group). With --load, local list entries are copied like
344
+ any other track file.
345
345
 
346
346
  --density attaches a features-per-bin bigWig (jbrowse make-density) as the
347
347
  adapter's densityAdapter, the band a display draws where the region is too large
348
348
  to fetch features. A local <file>.density.bw beside the track file is attached
349
349
  without the flag; a URL cannot be probed, so a remote sidecar needs it. The
350
- adapters carrying the slot are BamAdapter, CramAdapter, HtsgetBamAdapter,
350
+ adapters with the slot are BamAdapter, CramAdapter, HtsgetBamAdapter,
351
351
  Gff3TabixAdapter, GtfTabixAdapter, BedTabixAdapter, BigBedAdapter,
352
352
  VcfTabixAdapter and SplitVcfTabixAdapter.
353
353
 
@@ -382,7 +382,7 @@ $ jbrowse add-track genes.gff3.gz --load copy --color 'jexl:feature.strand==1?"b
382
382
  # bundle several BigWigs into one MultiQuantitativeTrack (no positional track arg)
383
383
  $ jbrowse add-track --multiwig a.bw,b.bw,c.bw --load copy --name "Coverage"
384
384
 
385
- # ...or from a sources.json carrying per-row name/color for each BigWig
385
+ # ...or from a sources.json with per-row name/color for each BigWig
386
386
  $ jbrowse add-track --multiwig sources.json --name "CATlas ATAC"
387
387
 
388
388
  # attach a remote density sidecar (a local genes.gff3.density.bw needs no flag)
@@ -429,7 +429,7 @@ what it cannot draw in a corner notice rather than refusing the track. This
429
429
  command runs the display's own rule list over every "marks" list in the file: an
430
430
  error where a mark draws nothing, never draws or a step cannot run, and a
431
431
  warning where a slot waits unread or the marks draw in an arrangement the author
432
- may not have meant. With --json each finding carries the stable "rule" id of the
432
+ may not have meant. With --json each finding has the stable "rule" id of the
433
433
  rule that made it.
434
434
 
435
435
  Types registered by plugins are not known to this command, so they come through
@@ -756,7 +756,7 @@ SplitVcfTabixAdapter declare. add-track attaches it on its own when the default
756
756
  <file>.density.bw sits beside the track file, so building it before adding the
757
757
  track is all it takes; --density attaches one by path or URL.
758
758
 
759
- GFF3 counts only top-level features — a line whose attributes carry no Parent= —
759
+ GFF3 counts only top-level features — a line whose attributes have no Parent= —
760
760
  so a gene is one count rather than one per exon. GTF, BED and VCF have no parent
761
761
  link to follow, so every record counts.
762
762
 
@@ -1,5 +1,5 @@
1
1
  import fs from 'node:fs';
2
- import { adapterTypesToTrackTypeMap, formats, matchFormat, resolveIndexType, sidecarCandidateNames, trackTypeForAdapter, } from '@jbrowse/add-track-core';
2
+ import { adapterTypesToTrackTypeMap, fileNameOf, formats, matchFormat, resolveIndexType, sidecarCandidateNames, trackTypeForAdapter, } from '@jbrowse/add-track-core';
3
3
  import { isURL } from '../../types/common.js';
4
4
  import { densitySidecarPath } from '../shared/density.js';
5
5
  import { configManifest } from '../validate/configManifest.generated.js';
@@ -134,14 +134,6 @@ export function makeLocationProtocol(protocol) {
134
134
  throw new Error(`invalid protocol ${protocol}`);
135
135
  };
136
136
  }
137
- /**
138
- * The bare filename the format table matches against — the same thing
139
- * `@jbrowse/core`'s `getFileName` hands the guesser chain, so a path and a URL
140
- * with a presigned query string both reduce to what the regexes expect.
141
- */
142
- export function fileNameOf(location) {
143
- return (location.replaceAll('\\', '/').split('/').at(-1)?.split(/[?#]/)[0] ?? '');
144
- }
145
137
  // resolves the file-layout spec that both the adapter config and the copied
146
138
  // file set derive from, honoring an explicit --adapterType. `typeOverride` is
147
139
  // the label to stamp on the adapter when the extension's layout is reused under
@@ -136,13 +136,13 @@ export async function run(args) {
136
136
  '--multiwig bundles several BigWigs into one MultiQuantitativeTrack, in ' +
137
137
  'place of the positional track argument: pass a comma-separated list of ' +
138
138
  'BigWig files/URLs, or a .json file with an array of BigWig locations or ' +
139
- 'subadapter objects (each carrying its own name/color/group). With --load, ' +
139
+ 'subadapter objects (each with its own name/color/group). With --load, ' +
140
140
  'local list entries are copied like any other track file.\n\n' +
141
141
  '--density attaches a features-per-bin bigWig (jbrowse make-density) as the ' +
142
142
  "adapter's densityAdapter, the band a display draws where the region is too " +
143
143
  'large to fetch features. A local <file>.density.bw beside the track file is ' +
144
144
  'attached without the flag; a URL cannot be probed, so a remote sidecar needs ' +
145
- 'it. The adapters carrying the slot are BamAdapter, CramAdapter, ' +
145
+ 'it. The adapters with the slot are BamAdapter, CramAdapter, ' +
146
146
  'HtsgetBamAdapter, Gff3TabixAdapter, GtfTabixAdapter, BedTabixAdapter, ' +
147
147
  'BigBedAdapter, VcfTabixAdapter and SplitVcfTabixAdapter.\n\n' +
148
148
  'For pairwise synteny adapters (PAF/Delta/Chain) --assemblyNames is ' +
@@ -174,7 +174,7 @@ export async function run(args) {
174
174
  '# bundle several BigWigs into one MultiQuantitativeTrack (no positional track arg)',
175
175
  '$ jbrowse add-track --multiwig a.bw,b.bw,c.bw --load copy --name "Coverage"',
176
176
  '',
177
- '# ...or from a sources.json carrying per-row name/color for each BigWig',
177
+ '# ...or from a sources.json with per-row name/color for each BigWig',
178
178
  '$ jbrowse add-track --multiwig sources.json --name "CATlas ATAC"',
179
179
  '',
180
180
  '# attach a remote density sidecar (a local genes.gff3.density.bw needs no flag)',
@@ -46,7 +46,7 @@ export async function run(args) {
46
46
  'SplitVcfTabixAdapter declare. add-track attaches it on its own when the ' +
47
47
  'default <file>.density.bw sits beside the track file, so building it before ' +
48
48
  'adding the track is all it takes; --density attaches one by path or URL.\n\n' +
49
- 'GFF3 counts only top-level features — a line whose attributes carry no ' +
49
+ 'GFF3 counts only top-level features — a line whose attributes have no ' +
50
50
  'Parent= — so a gene is one count rather than one per exon. GTF, BED and VCF ' +
51
51
  'have no parent link to follow, so every record counts.\n\n' +
52
52
  'BAM and CRAM are out of scope: read depth is not feature density, and the ' +