-
Notifications
You must be signed in to change notification settings - Fork 0
/
sc-wnn-cluster.cwl
971 lines (874 loc) · 28 KB
/
sc-wnn-cluster.cwl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
cwlVersion: v1.0
class: CommandLineTool
requirements:
- class: InlineJavascriptRequirement
- class: EnvVarRequirement
envDef:
R_MAX_VSIZE: $((inputs.vector_memory_limit * 1000000000).toString())
hints:
- class: DockerRequirement
dockerPull: biowardrobe2/sc-tools:v0.0.13
inputs:
query_data_rds:
type: File
inputBinding:
prefix: "--query"
doc: |
Path to the RDS file to load Seurat object from. This file should include
genes expression and chromatin accessibility information stored in the RNA
and ATAC assays correspondingly. Additionally, 'pca', 'rnaumap', 'atac_lsi'
and 'atacumap' dimensionality reductions should be present.
rna_dimensions:
type:
- "null"
- int
- int[]
inputBinding:
prefix: "--rnadimensions"
doc: |
Dimensionality from the 'pca' reduction to use when constructing weighted
nearest-neighbor graph before clustering (from 1 to 50). If single value N
is provided, use from 1 to N dimensions. If multiple values are provided,
subset to only selected dimensions.
Default: from 1 to 10
atac_dimensions:
type:
- "null"
- int
- int[]
inputBinding:
prefix: "--atacdimensions"
doc: |
Dimensionality from the 'atac_lsi' reduction to use when constructing weighted
nearest-neighbor graph before clustering (from 1 to 50). If single value N
is provided, use from 2 to N dimensions. If multiple values are provided,
subset to only selected dimensions.
Default: from 2 to 10
cluster_algorithm:
type:
- "null"
- type: enum
symbols:
- "louvain"
- "mult-louvain"
- "slm"
- "leiden"
inputBinding:
prefix: "--algorithm"
doc: |
Algorithm for modularity optimization when running clustering.
Default: slm
umap_spread:
type: float?
inputBinding:
prefix: "--uspread"
doc: |
The effective scale of embedded points on UMAP. In combination with '--mindist'
it determines how clustered/clumped the embedded points are.
Default: 1
umap_mindist:
type: float?
inputBinding:
prefix: "--umindist"
doc: |
Controls how tightly the embedding is allowed compress points together on UMAP.
Larger values ensure embedded points are moreevenly distributed, while smaller
values allow the algorithm to optimise more accurately with regard to local structure.
Sensible values are in the range 0.001 to 0.5.
Default: 0.3
umap_neighbors:
type: int?
inputBinding:
prefix: "--uneighbors"
doc: |
Determines the number of neighboring points used in UMAP. Larger values will result
in more global structure being preserved at the loss of detailed local structure.
In general this parameter should often be in the range 5 to 50.
Default: 30
umap_metric:
type:
- "null"
- type: enum
symbols:
- "euclidean"
- "manhattan"
- "chebyshev"
- "minkowski"
- "canberra"
- "braycurtis"
- "mahalanobis"
- "wminkowski"
- "seuclidean"
- "cosine"
- "correlation"
- "haversine"
- "hamming"
- "jaccard"
- "dice"
- "russelrao"
- "kulsinski"
- "ll_dirichlet"
- "hellinger"
- "rogerstanimoto"
- "sokalmichener"
- "sokalsneath"
- "yule"
inputBinding:
prefix: "--umetric"
doc: |
The metric to use to compute distances in high dimensional space for UMAP.
Default: cosine
umap_method:
type:
- "null"
- type: enum
symbols:
- "uwot"
- "uwot-learn"
- "umap-learn"
inputBinding:
prefix: "--umethod"
doc: |
UMAP implementation to run. If set to 'umap-learn' use --umetric 'correlation'
Default: uwot
resolution:
type:
- "null"
- float
- float[]
inputBinding:
prefix: "--resolution"
doc: |
Clustering resolution applied to the constructed weighted nearest-neighbor
graph. Can be set as an array.
Default: 0.3, 0.5, 1.0
atac_fragments_file:
type: File?
secondaryFiles:
- .tbi
inputBinding:
prefix: "--fragments"
doc: |
Count and barcode information for every ATAC fragment used in the loaded Seurat
object. File should be saved in TSV format with tbi-index file.
genes_of_interest:
type:
- "null"
- string
- string[]
inputBinding:
prefix: "--genes"
doc: |
Genes of interest to build gene expression and Tn5 insertion frequency plots
for the nearest peaks. If '--fragments' is not provided only gene expression
plots will be built.
Default: None
identify_diff_genes:
type: boolean?
inputBinding:
prefix: "--diffgenes"
doc: |
Identify differentially expressed genes (putative gene markers) between each
pair of clusters for all resolutions.
Default: false
identify_diff_peaks:
type: boolean?
inputBinding:
prefix: "--diffpeaks"
doc: |
Identify differentially accessible peaks between each pair of clusters for all resolutions.
Default: false
rna_minimum_logfc:
type: float?
inputBinding:
prefix: "--rnalogfc"
doc: |
For putative gene markers identification include only those genes that
on average have log fold change difference in expression between every
tested pair of clusters not lower than this value. Ignored if '--diffgenes'
is not set.
Default: 0.25
rna_minimum_pct:
type: float?
inputBinding:
prefix: "--rnaminpct"
doc: |
For putative gene markers identification include only those genes that
are detected in not lower than this fraction of cells in either of the
two tested clusters. Ignored if '--diffgenes' is not set.
Default: 0.1
only_positive_diff_genes:
type: boolean?
inputBinding:
prefix: "--rnaonlypos"
doc: |
For putative gene markers identification return only positive markers.
Ignored if '--diffgenes' is not set.
Default: false
rna_test_to_use:
type:
- "null"
- type: enum
symbols:
- "wilcox"
- "bimod"
- "roc"
- "t"
- "negbinom"
- "poisson"
- "LR"
- "MAST"
- "DESeq2"
inputBinding:
prefix: "--rnatestuse"
doc: |
Statistical test to use for putative gene markers identification.
Ignored if '--diffgenes' is not set.
Default: wilcox
atac_minimum_logfc:
type: float?
inputBinding:
prefix: "--ataclogfc"
doc: |
For differentially accessible peaks identification include only those peaks that
on average have log fold change difference in the chromatin accessibility between
every tested pair of clusters not lower than this value. Ignored if '--diffpeaks'
is not set.
Default: 0.25
atac_minimum_pct:
type: float?
inputBinding:
prefix: "--atacminpct"
doc: |
For differentially accessible peaks identification include only those peaks that
are detected in not lower than this fraction of cells in either of the two tested
clusters. Ignored if '--diffpeaks' is not set.
Default: 0.05
atac_test_to_use:
type:
- "null"
- type: enum
symbols:
- "wilcox"
- "bimod"
- "roc"
- "t"
- "negbinom"
- "poisson"
- "LR"
- "MAST"
- "DESeq2"
inputBinding:
prefix: "--atactestuse"
doc: |
Statistical test to use for differentially accessible peaks identification.
Ignored if '--diffpeaks' is not set.
Default: LR
export_pdf_plots:
type: boolean?
inputBinding:
prefix: "--pdf"
doc: |
Export plots in PDF.
Default: false
color_theme:
type:
- "null"
- type: enum
symbols:
- "gray"
- "bw"
- "linedraw"
- "light"
- "dark"
- "minimal"
- "classic"
- "void"
inputBinding:
prefix: "--theme"
doc: |
Color theme for all generated plots. One of gray, bw, linedraw, light,
dark, minimal, classic, void.
Default: classic
verbose:
type: boolean?
inputBinding:
prefix: "--verbose"
doc: |
Print debug information.
Default: false
export_h5seurat_data:
type: boolean?
inputBinding:
prefix: "--h5seurat"
doc: |
Save Seurat data to h5seurat file.
Default: false
export_h5ad_data:
type: boolean?
inputBinding:
prefix: "--h5ad"
doc: |
Save Seurat data to h5ad file.
Default: false
export_ucsc_cb:
type: boolean?
inputBinding:
prefix: "--cbbuild"
doc: |
Export results to UCSC Cell Browser. Default: false
output_prefix:
type: string?
inputBinding:
prefix: "--output"
doc: |
Output prefix.
Default: ./sc
parallel_memory_limit:
type: int?
inputBinding:
prefix: "--memory"
doc: |
Maximum memory in GB allowed to be shared between the workers
when using multiple --cpus.
Default: 32
vector_memory_limit:
type: int?
default: 128
doc: |
Maximum vector memory in GB allowed to be used by R.
Default: 128
threads:
type: int?
inputBinding:
prefix: "--cpus"
doc: |
Number of cores/cpus to use.
Default: 1
outputs:
umap_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_res_*.png"
doc: |
Clustered cells UMAP.
PNG format
umap_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_res_*.pdf"
doc: |
Clustered cells UMAP.
PDF format
umap_spl_idnt_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_spl_idnt_res_*.png"
doc: |
Split by dataset clustered cells UMAP.
PNG format
umap_spl_idnt_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_spl_idnt_res_*.pdf"
doc: |
Split by dataset clustered cells UMAP.
PDF format
cmp_gr_clst_spl_idnt_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_clst_spl_idnt_res_*.png"
doc: |
Grouped by cluster split by dataset cells composition plot. Downsampled.
PNG format
cmp_gr_clst_spl_idnt_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_clst_spl_idnt_res_*.pdf"
doc: |
Grouped by cluster split by dataset cells composition plot. Downsampled.
PDF format
cmp_gr_idnt_spl_clst_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_idnt_spl_clst_res_*.png"
doc: |
Grouped by dataset split by cluster cells composition plot. Downsampled.
PNG format
cmp_gr_idnt_spl_clst_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_idnt_spl_clst_res_*.pdf"
doc: |
Grouped by dataset split by cluster cells composition plot. Downsampled.
PDF format
umap_spl_cnd_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_spl_cnd_res_*.png"
doc: |
Split by grouping condition clustered cells UMAP.
PNG format
umap_spl_cnd_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_spl_cnd_res_*.pdf"
doc: |
Split by grouping condition clustered cells UMAP.
PDF format
cmp_gr_clst_spl_cnd_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_clst_spl_cnd_res_*.png"
doc: |
Grouped by cluster split by condition cells composition plot. Downsampled.
PNG format
cmp_gr_clst_spl_cnd_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_clst_spl_cnd_res_*.pdf"
doc: |
Grouped by cluster split by condition cells composition plot. Downsampled.
PDF format
cmp_gr_cnd_spl_clst_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_cnd_spl_clst_res_*.png"
doc: |
Grouped by condition split by cluster cells composition plot. Downsampled.
PNG format
cmp_gr_cnd_spl_clst_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_cnd_spl_clst_res_*.pdf"
doc: |
Grouped by condition split by cluster cells composition plot. Downsampled.
PDF format
umap_spl_ph_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_spl_ph_res_*.png"
doc: |
Split by cell cycle phase clustered cells UMAP.
PNG format
umap_spl_ph_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_umap_spl_ph_res_*.pdf"
doc: |
Split by cell cycle phase clustered cells UMAP.
PDF format
cmp_gr_ph_spl_idnt_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_ph_spl_idnt_res_*.png"
doc: |
Grouped by cell cycle phase split by dataset cells composition plot. Downsampled.
PNG format
cmp_gr_ph_spl_idnt_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_ph_spl_idnt_res_*.pdf"
doc: |
Grouped by cell cycle phase split by dataset cells composition plot. Downsampled.
PDF format
cmp_gr_ph_spl_clst_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_ph_spl_clst_res_*.png"
doc: |
Grouped by cell cycle phase split by cluster cells composition plot. Downsampled.
PNG format
cmp_gr_ph_spl_clst_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cmp_gr_ph_spl_clst_res_*.pdf"
doc: |
Grouped by cell cycle phase split by cluster cells composition plot. Downsampled.
PDF format
xpr_avg_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_avg_res_*.png"
doc: |
Log normalized scaled average gene expression per cluster.
PNG format
xpr_avg_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_avg_res_*.pdf"
doc: |
Log normalized scaled average gene expression per cluster.
PDF format
xpr_per_cell_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_per_cell_res_*.png"
doc: |
Log normalized gene expression on cells UMAP.
PNG format
xpr_per_cell_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_per_cell_res_*.pdf"
doc: |
Log normalized gene expression on cells UMAP.
PDF format
xpr_per_cell_sgnl_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_per_cell_sgnl_res_*.png"
doc: |
Log normalized gene expression density on cells UMAP.
PNG format
xpr_per_cell_sgnl_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_per_cell_sgnl_res_*.pdf"
doc: |
Log normalized gene expression density on cells UMAP.
PDF format
xpr_dnst_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_dnst_res_*.png"
doc: |
Log normalized gene expression density per cluster.
PNG format
xpr_dnst_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_xpr_dnst_res_*.pdf"
doc: |
Log normalized gene expression density per cluster.
PDF format
cvrg_res_plot_png:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cvrg_res_*.png"
doc: |
Tn5 insertion frequency plot around gene.
PNG format
cvrg_res_plot_pdf:
type:
- "null"
- type: array
items: File
outputBinding:
glob: "*_cvrg_res_*.pdf"
doc: |
Tn5 insertion frequency plot around gene.
PDF format
gene_markers_tsv:
type: File?
outputBinding:
glob: "*_gene_markers.tsv"
doc: |
Differentially expressed genes between each pair of clusters for all resolutions.
TSV format
peak_markers_tsv:
type: File?
outputBinding:
glob: "*_peak_markers.tsv"
doc: |
Differentially accessible peaks between each pair of clusters for all resolutions.
TSV format
ucsc_cb_config_data:
type: Directory?
outputBinding:
glob: "*_cellbrowser"
doc: |
Directory with UCSC Cellbrowser configuration data.
ucsc_cb_html_data:
type: Directory?
outputBinding:
glob: "*_cellbrowser/html_data"
doc: |
Directory with UCSC Cellbrowser html data.
ucsc_cb_html_file:
type: File?
outputBinding:
glob: "*_cellbrowser/html_data/index.html"
doc: |
HTML index file from the directory with UCSC Cellbrowser html data.
seurat_data_rds:
type: File
outputBinding:
glob: "*_data.rds"
doc: |
Reduced Seurat data in RDS format
seurat_data_h5seurat:
type: File?
outputBinding:
glob: "*_data.h5seurat"
doc: |
Reduced Seurat data in h5seurat format
seurat_data_h5ad:
type: File?
outputBinding:
glob: "*_data.h5ad"
doc: |
Reduced Seurat data in h5ad format
stdout_log:
type: stdout
stderr_log:
type: stderr
baseCommand: ["sc_wnn_cluster.R"]
stdout: sc_wnn_cluster_stdout.log
stderr: sc_wnn_cluster_stderr.log
$namespaces:
s: http://schema.org/
$schemas:
- https://github.com/schemaorg/schemaorg/raw/main/data/releases/11.01/schemaorg-current-http.rdf
label: "Single-cell WNN Cluster Analysis"
s:name: "Single-cell WNN Cluster Analysis"
s:alternateName: "Clusters multiome ATAC and RNA-Seq datasets, identifies gene markers and differentially accessible peaks"
s:downloadUrl: https://raw.githubusercontent.com/Barski-lab/workflows/master/tools/sc-wnn-cluster.cwl
s:codeRepository: https://github.com/Barski-lab/workflows
s:license: http://www.apache.org/licenses/LICENSE-2.0
s:isPartOf:
class: s:CreativeWork
s:name: Common Workflow Language
s:url: http://commonwl.org/
s:creator:
- class: s:Organization
s:legalName: "Cincinnati Children's Hospital Medical Center"
s:location:
- class: s:PostalAddress
s:addressCountry: "USA"
s:addressLocality: "Cincinnati"
s:addressRegion: "OH"
s:postalCode: "45229"
s:streetAddress: "3333 Burnet Ave"
s:telephone: "+1(513)636-4200"
s:logo: "https://www.cincinnatichildrens.org/-/media/cincinnati%20childrens/global%20shared/childrens-logo-new.png"
s:department:
- class: s:Organization
s:legalName: "Allergy and Immunology"
s:department:
- class: s:Organization
s:legalName: "Barski Research Lab"
s:member:
- class: s:Person
s:name: Michael Kotliar
s:email: mailto:[email protected]
s:sameAs:
- id: http://orcid.org/0000-0002-6486-3898
doc: |
Single-cell WNN Cluster Analysis
Clusters multiome ATAC and RNA-Seq datasets, identifies gene markers
and differentially accessible peaks.
s:about: |
usage: sc_wnn_cluster.R
[-h] --query QUERY [--rnadimensions [RNADIMENSIONS ...]]
[--atacdimensions [ATACDIMENSIONS ...]]
[--algorithm {louvain,mult-louvain,slm,leiden}] [--uspread USPREAD]
[--umindist UMINDIST] [--uneighbors UNEIGHBORS]
[--umetric {euclidean,manhattan,chebyshev,minkowski,canberra,braycurtis,mahalanobis,wminkowski,seuclidean,cosine,correlation,haversine,hamming,jaccard,dice,russelrao,kulsinski,ll_dirichlet,hellinger,rogerstanimoto,sokalmichener,sokalsneath,yule}]
[--umethod {uwot,uwot-learn,umap-learn}]
[--resolution [RESOLUTION ...]] [--fragments FRAGMENTS]
[--genes [GENES ...]] [--diffgenes] [--diffpeaks] [--rnalogfc RNALOGFC]
[--rnaminpct RNAMINPCT] [--rnaonlypos]
[--rnatestuse {wilcox,bimod,roc,t,negbinom,poisson,LR,MAST,DESeq2}]
[--ataclogfc ATACLOGFC] [--atacminpct ATACMINPCT]
[--atactestuse {wilcox,bimod,roc,t,negbinom,poisson,LR,MAST,DESeq2}]
[--pdf] [--verbose] [--h5seurat] [--h5ad] [--cbbuild] [--output OUTPUT]
[--theme {gray,bw,linedraw,light,dark,minimal,classic,void}]
[--cpus CPUS] [--memory MEMORY]
Single-cell WNN Cluster Analysis
options:
-h, --help show this help message and exit
--query QUERY Path to the RDS file to load Seurat object from. This
file should include genes expression and chromatin
accessibility information stored in the RNA and ATAC
assays correspondingly. Additionally, 'pca',
'rnaumap', 'atac_lsi' and 'atacumap' dimensionality
reductions should be present.
--rnadimensions [RNADIMENSIONS ...]
Dimensionality from the 'pca' reduction to use when
constructing weighted nearest-neighbor graph before
clustering (from 1 to 50). If single value N is
provided, use from 1 to N dimensions. If multiple
values are provided, subset to only selected
dimensions. Default: from 1 to 10
--atacdimensions [ATACDIMENSIONS ...]
Dimensionality from the 'atac_lsi' reduction to use
when constructing weighted nearest-neighbor graph
before clustering (from 1 to 50). If single value N is
provided, use from 2 to N dimensions. If multiple
values are provided, subset to only selected
dimensions. Default: from 2 to 10
--algorithm {louvain,mult-louvain,slm,leiden}
Algorithm for modularity optimization when running
clustering. Default: louvain
--uspread USPREAD The effective scale of embedded points on UMAP. In
combination with '--mindist' it determines how
clustered/clumped the embedded points are. Default: 1
--umindist UMINDIST Controls how tightly the embedding is allowed compress
points together on UMAP. Larger values ensure embedded
points are moreevenly distributed, while smaller
values allow the algorithm to optimise more accurately
with regard to local structure. Sensible values are in
the range 0.001 to 0.5. Default: 0.3
--uneighbors UNEIGHBORS
Determines the number of neighboring points used in
UMAP. Larger values will result in more global
structure being preserved at the loss of detailed
local structure. In general this parameter should
often be in the range 5 to 50. Default: 30
--umetric {euclidean,manhattan,chebyshev,minkowski,canberra,braycurtis,mahalanobis,wminkowski,seuclidean,cosine,correlation,haversine,hamming,jaccard,dice,russelrao,kulsinski,ll_dirichlet,hellinger,rogerstanimoto,sokalmichener,sokalsneath,yule}
The metric to use to compute distances in high
dimensional space for UMAP. Default: cosine
--umethod {uwot,uwot-learn,umap-learn}
UMAP implementation to run. If set to 'umap-learn' use
--umetric 'correlation' Default: uwot
--resolution [RESOLUTION ...]
Clustering resolution applied to the constructed
weighted nearest-neighbor graph. Can be set as an
array. Default: 0.3, 0.5, 1.0
--fragments FRAGMENTS
Count and barcode information for every ATAC fragment
used in the loaded Seurat object. File should be saved
in TSV format with tbi-index file.
--genes [GENES ...] Genes of interest to build gene expression and Tn5
insertion frequency plots for the nearest peaks. If '
--fragments' is not provided only gene expression
plots will be built. Default: None
--diffgenes Identify differentially expressed genes (putative gene
markers) between each pair of clusters for all
resolutions. Default: false
--diffpeaks Identify differentially accessible peaks between each
pair of clusters for all resolutions. Default: false
--rnalogfc RNALOGFC For putative gene markers identification include only
those genes that on average have log fold change
difference in expression between every tested pair of
clusters not lower than this value. Ignored if '--
diffgenes' is not set. Default: 0.25
--rnaminpct RNAMINPCT
For putative gene markers identification include only
those genes that are detected in not lower than this
fraction of cells in either of the two tested
clusters. Ignored if '--diffgenes' is not set.
Default: 0.1
--rnaonlypos For putative gene markers identification return only
positive markers. Ignored if '--diffgenes' is not set.
Default: false
--rnatestuse {wilcox,bimod,roc,t,negbinom,poisson,LR,MAST,DESeq2}
Statistical test to use for putative gene markers
identification. Ignored if '--diffgenes' is not set.
Default: wilcox
--ataclogfc ATACLOGFC
For differentially accessible peaks identification
include only those peaks that on average have log fold
change difference in the chromatin accessibility
between every tested pair of clusters not lower than
this value. Ignored if '--diffpeaks' is not set.
Default: 0.25
--atacminpct ATACMINPCT
For differentially accessible peaks identification
include only those peaks that are detected in not
lower than this fraction of cells in either of the two
tested clusters. Ignored if '--diffpeaks' is not set.
Default: 0.05
--atactestuse {wilcox,bimod,roc,t,negbinom,poisson,LR,MAST,DESeq2}
Statistical test to use for differentially accessible
peaks identification. Ignored if '--diffpeaks' is not
set. Default: LR
--pdf Export plots in PDF. Default: false
--verbose Print debug information. Default: false
--h5seurat Save Seurat data to h5seurat file. Default: false
--h5ad Save Seurat data to h5ad file. Default: false
--cbbuild Export results to UCSC Cell Browser. Default: false
--output OUTPUT Output prefix. Default: ./sc
--theme {gray,bw,linedraw,light,dark,minimal,classic,void}
Color theme for all generated plots. Default: classic
--cpus CPUS Number of cores/cpus to use. Default: 1
--memory MEMORY Maximum memory in GB allowed to be shared between the
workers when using multiple --cpus. Default: 32