-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.xml
More file actions
2039 lines (1692 loc) · 130 KB
/
index.xml
File metadata and controls
2039 lines (1692 loc) · 130 KB
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
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>dynverse</title>
<link>/</link>
<description>Recent content on dynverse</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Mon, 08 Apr 2019 00:00:00 +0000</lastBuildDate>
<atom:link href="/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Creating a trajectory</title>
<link>/developers/creating-ti-method/create_ti_method_wrappers/</link>
<pubDate>Mon, 08 Apr 2019 00:00:00 +0000</pubDate>
<guid>/developers/creating-ti-method/create_ti_method_wrappers/</guid>
<description>Common trajectory model dynwrap always represents trajectories in the same way, as illustrated here with a tree trajectory
Milestone network, contains information of connections between milestones ## # A tibble: 5 x 4 ## from to length directed ## &lt;chr&gt; &lt;chr&gt; &lt;dbl&gt; &lt;lgl&gt; ## 1 Milestone_A Milestone_B 1 FALSE ## 2 Milestone_B Milestone_C 2 FALSE ## 3 Milestone_B Milestone_D 1 FALSE ## 4 Milestone_C Milestone_E 1 FALSE ## 5 Milestone_C Milestone_F 1.</description>
</item>
<item>
<title>Installation</title>
<link>/users/1-installation/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/1-installation/</guid>
<description>Dyno Docker Singularity Frequent installation problems API rate limit exceeded I’m not allowed to install docker on my shared cluster Dyno dyno contains and loads several of the dynverse R packages (dynwrap, dynplot, dynmethods, …). To install (and update) them all:
# install.packages(&quot;devtools&quot;) devtools::install_github(&quot;dynverse/dyno&quot;) On Linux, you will need to install udunits and ImageMagick:
Debian / Ubuntu / Linux Mint: sudo apt-get install libudunits2-dev imagemagick Fedora / CentOS / RHEL: sudo dnf install udunits2-devel ImageMagick-c++-devel Docker or Singularity (version ≥ 3.</description>
</item>
<item>
<title>Preparing the data</title>
<link>/users/3-user-guide/1-preparing/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/3-user-guide/1-preparing/</guid>
<description>Gene expression data Prior information Optional information Grouping / clustering Dimensionality reduction Current limitations library(dyno) library(tidyverse) The main functions to wrap a dataset are included within the dynwrap package.
Gene expression data As input, dynwrap requires raw counts and normalised (log2) expression data. Cells with low expression, doublets and other “bad” cells should already be filtered from this matrix. Features (i.e. genes) may already be filtered, but this is not required.</description>
</item>
<item>
<title>Wrapping in R</title>
<link>/developers/creating-ti-method/create_ti_method_r/</link>
<pubDate>Tue, 09 Apr 2019 00:00:00 +0000</pubDate>
<guid>/developers/creating-ti-method/create_ti_method_r/</guid>
<description>library(dynwrap) This vignette describes how to include your own method into the dynverse workflow. We’ll illustrate this with a very basic method: using one of the components of a PCA as the pseudotime.
A method defined in R has two parts: a definition and a function.
Definition The definition contains information on the method, its parameters and its required or optional inputs. The possibilities are quite extensive (see dynwrap::definition()), but essentials are:</description>
</item>
<item>
<title>Quick start</title>
<link>/users/2-quick_start/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/2-quick_start/</guid>
<description>Preparing the data Selecting the best methods for a dataset Running the methods Plotting the trajectory Interpreting the trajectory biologically Rooting Milestone labelling Predicting and visualising genes of interest A global overview of the most predictive genes Lineage/branch markers Genes important at bifurcation points library(dyno) library(tidyverse) This tutorial quickly guides you through the main steps in the dyno workflow. For each step, we also provide a more in-depth tutorial in the user guide section.</description>
</item>
<item>
<title>Selecting the best methods for a dataset</title>
<link>/users/3-user-guide/2-guidelines/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/3-user-guide/2-guidelines/</guid>
<description>library(dyno) library(tidyverse) Within our evaluation study, we compared 45 methods on four aspects:
Accuracy: How similar is the inferred trajectory to the “true” (or “expected”) trajectory in the data. We used several metrics for this, comparing the cellular ordering and topology, and compared against both real datasets, for which a gold standard is not always so well defined, and synthetic data, which are not necessarily as biologically relevant as real data.</description>
</item>
<item>
<title>Wrapper script</title>
<link>/developers/creating-ti-method/create_ti_method_script/</link>
<pubDate>Mon, 08 Apr 2019 00:00:00 +0000</pubDate>
<guid>/developers/creating-ti-method/create_ti_method_script/</guid>
<description>library(dynwrap) library(dyncli) An alternative to wrapping a script inside R, is to wrap it using an external script. Because this does not provide any dependency management, this is not really useful for method end-users, but rather as a way to easily develop a TI method and to ultimately step up towards containerised wrapping.
Similarly as a wrapper written in R, you’ll need to provide both a definition (= a definition.</description>
</item>
<item>
<title>Inferring trajectories</title>
<link>/users/3-user-guide/3-running/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/3-user-guide/3-running/</guid>
<description>Parameters Priors Reproducibility Running multiple methods or datasets Errors Running from the command line library(dyno) library(tidyverse) dynwrap::infer_trajectory is the main function to infer a trajectory. It requires two things:
A dataset, wrapped using dynwrap::wrap_expression A TI method. This can be one of the 59 TI method from dynmethods, or a name of a method in which case it will retrieve the relevant method from dynmethods. dataset &lt;- wrap_expression( counts = example_dataset$counts, expression = example_dataset$expression ) model &lt;- infer_trajectory(dataset, ti_comp1()) ## Loading required namespace: hdf5r This model now contains the main information on the trajectory, i.</description>
</item>
<item>
<title>Containerised wrapping</title>
<link>/developers/creating-ti-method/create_ti_method_container/</link>
<pubDate>Mon, 08 Apr 2019 00:00:00 +0000</pubDate>
<guid>/developers/creating-ti-method/create_ti_method_container/</guid>
<description>library(dynwrap) library(dplyr) Once you have wrapped a method using a script and definition, all you need to share your method is a Dockerfile which lists all the dependencies that need to be installed.
We’ll work with the following definition.yml:
definition.yml method: id: comp_1 parameters: - id: component default: 1 type: integer distribution: type: uniform lower: 1 upper: 10 description: The nth component to use wrapper: input_required: expression input_optional: start_id and run.</description>
</item>
<item>
<title>Visualising the trajectory</title>
<link>/users/3-user-guide/4-visualisation/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/3-user-guide/4-visualisation/</guid>
<description>Visualising the trajectory on a dimensionality reduction Plotting the trajectory itself Plotting in a dendrogram Plotting as a graph Plotting in one dimension Visualising many genes along a trajectory library(dyno) library(tidyverse) The main functions for plotting a trajectory are included in the dynplot package.
We’ll use an example toy dataset
set.seed(1) dataset &lt;- dyntoy::generate_dataset(model = &quot;bifurcating&quot;, num_cells = 200) To visualise a trajectory, you have to take into acount two things:</description>
</item>
<item>
<title>Adapting the trajectory</title>
<link>/users/3-user-guide/5-adapting/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/3-user-guide/5-adapting/</guid>
<description>Simplifying Rooting Manually Using marker genes Annotating Manually Using marker genes Limitations library(dyno) library(tidyverse) Simplifying Intermediate milestones can be removed by simplyfing the trajectory:
model &lt;- dyntoy::generate_dataset(model = dyntoy::model_linear(num_milestones = 10)) simplified &lt;- simplify_trajectory(model) Rooting TI methods often do not have an idea where the root of a trajectory is. We provide two ways of rooting a trajectory. After rooting, all other edges will point away from the root.</description>
</item>
<item>
<title>Trajectory differentially expression</title>
<link>/users/3-user-guide/6-tde/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/users/3-user-guide/6-tde/</guid>
<description>A global overview of the most predictive genes Lineage/branch markers Genes important at bifurcation points Current limitations library(dyno) library(tidyverse) Compared to differential expression between clusters of cells, defining differential expression on trajectories is not so straightforward. What constitutes a trajectory differentially expressed gene?
A gene that is uniquely expressed in a particular branch? A gene that changes at a branching point? A gene that changes along pseudotime?</description>
</item>
<item>
<title></title>
<link>/about/contributing/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/about/contributing/</guid>
<description>Contributing /*! jQuery v1.11.3 | (c) 2005, 2015 jQuery Foundation, Inc. | jquery.org/license */ !function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.3",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0a?b:0);return this.pushStack(c=0&&bc?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);ih;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)+1=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.</description>
</item>
<item>
<title></title>
<link>/logo-accordion/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/logo-accordion/</guid>
<description>dynbenchmark Benchmarking dyneval Comparing dynplot Visualising &nbsp; &nbsp; dynwrap Wrapping dynguidelines Guidelines dynmethods Inferring /* top row: by default more to the top, unless on mobile */ .row.logos { margin-top:-25px; } @media only all and (max-width: 47.938em) { .row.logos { margin-top:0px; } } .outer-div { position: relative; float: right; right: 50%; } .</description>
</item>
<item>
<title></title>
<link>/page-top/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/page-top/</guid>
<description></description>
</item>
<item>
<title>"Gather" cells to their closest milestones</title>
<link>/reference/dynwrap/adapt_trajectory/gather_cells_at_milestones/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/gather_cells_at_milestones/</guid>
<description> Source: R/wrap_gather_cells_at_milestones.R gather_cells_at_milestones.Rd "Gather" cells to their closest milestones
gather_cells_at_milestones(trajectory) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
Contents Arguments -- </description>
</item>
<item>
<title>A DAG of trajectory types</title>
<link>/reference/dynwrap/create_ti_method/trajectory_type_dag/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/trajectory_type_dag/</guid>
<description> Source: R/data.R trajectory_type_dag.Rd A DAG of trajectory types
trajectory_type_dag Format An object of class tbl_graph (inherits from igraph) of length 10.
Contents Format -- </description>
</item>
<item>
<title>A data wrapper for datasets and trajectories</title>
<link>/reference/dynwrap/create_trajectory/wrap_data/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/wrap_data/</guid>
<description>Source: R/wrap_data.R wrap_data.Rd A data wrapper for datasets and trajectories
wrap_data(id = NULL, cell_ids, cell_info = NULL, ...) is_data_wrapper(dataset) Arguments id A unique identifier for the data. If NULL, a random string will be generated.
cell_ids The ids of the cells.
cell_info Optional meta-information pertaining the cells.
... Extra information to be stored in the wrapper.</description>
</item>
<item>
<title>Add a cell grouping to a dataset</title>
<link>/reference/dynwrap/adapt_trajectory/add_grouping/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/add_grouping/</guid>
<description>Source: R/wrap_add_grouping.R add_grouping.Rd Add a cell grouping to a dataset
add_grouping(dataset, grouping, group_ids = NULL, ...) is_wrapper_with_grouping(dataset) get_grouping(dataset, grouping = NULL) Arguments dataset A dataset created by wrap_data() or wrap_expression()
grouping A grouping of the cells, can be a named vector or a dataframe with group_id (character) and cell_id (character)
group_ids All group_ids, optional
... Extra information to be stored in the dataset</description>
</item>
<item>
<title>Add cell waypoints to a wrapped trajectory</title>
<link>/reference/dynwrap/adapt_trajectory/add_cell_waypoints/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/add_cell_waypoints/</guid>
<description> Source: R/wrap_add_cell_waypoints.R add_cell_waypoints.Rd Add cell waypoints to a wrapped trajectory
add_cell_waypoints(trajectory, num_cells_selected = 100) is_wrapper_with_waypoint_cells(trajectory) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
num_cells_selected About the number of cells selected as waypoints
Contents Arguments -- </description>
</item>
<item>
<title>Add coloring</title>
<link>/reference/dynplot/other/add_cell_coloring/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/other/add_cell_coloring/</guid>
<description>add_cell_coloring.Rd Add coloring
add_cell_coloring(cell_positions, color_cells = c("auto", "none", "grouping", "feature", "milestone", "pseudotime"), trajectory, grouping = NULL, groups = NULL, feature_oi = NULL, expression_source = "expression", pseudotime = NULL, color_milestones = c("auto", "given", "cubeHelix", "Set3", "rainbow"), milestones = NULL, milestone_percentages = NULL) Arguments cell_positions The positions of the cells
color_cells How to color the cells
trajectory The trajectory
grouping The grouping of the cells</description>
</item>
<item>
<title>Add count and normalised expression values to a dataset</title>
<link>/reference/dynwrap/adapt_trajectory/add_expression/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/add_expression/</guid>
<description>Source: R/wrap_add_expression.R add_expression.Rd Add count and normalised expression values to a dataset
add_expression(dataset, counts, expression, feature_info = NULL, ...) is_wrapper_with_expression(dataset) get_expression(dataset, expression_source = "expression") Arguments dataset A dataset created by wrap_data() or wrap_expression()
counts The counts with genes in columns and cells in rows
expression The normalised expression values with genes in columns and cells in rows
feature_info Optional meta-information of the features, a data.</description>
</item>
<item>
<title>Add information on overall differentially expressed features</title>
<link>/reference/dynwrap/adapt_trajectory/add_tde_overall/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/add_tde_overall/</guid>
<description> Source: R/wrap_add_tde_overall.R add_tde_overall.Rd Add information on overall differentially expressed features
add_tde_overall(trajectory, tde_overall) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
tde_overall A tibble containing a feature_id (character) and differentially_expressed (logical). Can also contain other columns, such as the p-value, q-value, log fold-change, etc
Contents Arguments -- </description>
</item>
<item>
<title>Add milestone coloring</title>
<link>/reference/dynplot/other/add_milestone_coloring/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/other/add_milestone_coloring/</guid>
<description> add_milestone_coloring.Rd Add milestone coloring
add_milestone_coloring(milestones = NULL, color_milestones = c("auto", "given", "cubeHelix", "Set3", "rainbow")) Arguments milestones Tibble containing the `milestone_id` and a `color` for each milestone
color_milestones How to color the cells
Contents Arguments -- </description>
</item>
<item>
<title>Add or calculate pseudotime as distance from the root</title>
<link>/reference/dynwrap/derive_trajectory/calculate_pseudotime/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/derive_trajectory/calculate_pseudotime/</guid>
<description> Source: R/wrap_add_pseudotime.R add_pseudotime.Rd Add or calculate pseudotime as distance from the root
calculate_pseudotime(trajectory) add_pseudotime(trajectory, pseudotime = NULL) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
pseudotime Named vector containing the pseudotime for every cell
Contents Arguments -- </description>
</item>
<item>
<title>Add or create a dimensionality reduction</title>
<link>/reference/dynwrap/adapt_trajectory/add_dimred/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/add_dimred/</guid>
<description>Source: R/wrap_add_dimred.R add_dimred.Rd Add or create a dimensionality reduction
add_dimred(dataset, dimred, dimred_milestones = NULL, dimred_segment_progressions = NULL, dimred_segment_points = NULL, connect_segments = FALSE, expression_source = "expression", ...) is_wrapper_with_dimred(dataset) get_dimred(dataset, dimred = NULL, expression_source = "expression") Arguments dataset A dataset created by wrap_data() or wrap_expression()
dimred The dimensionality reduction matrix (with cell_ids as rownames) or function which will run the dimensionality reduction
dimred_milestones An optional dimensionality reduction of the milestones.</description>
</item>
<item>
<title>Add or create waypoints to a trajectory</title>
<link>/reference/dynwrap/adapt_trajectory/add_waypoints/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/add_waypoints/</guid>
<description>Source: R/wrap_add_waypoints.R add_waypoints.Rd Add or create waypoints to a trajectory
Waypoints are spread equally over the whole trajectory
add_waypoints(trajectory, n_waypoints = 100, resolution = sum(trajectory$milestone_network$length)/n_waypoints) is_wrapper_with_waypoints(trajectory) select_waypoints(trajectory, n_waypoints = 100, resolution = sum(trajectory$milestone_network$length)/n_waypoints) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
n_waypoints The number of waypoints
resolution The resolution of the waypoints, measured in the same units as the lengths of the milestone network edges, will be automatically computed using n_waypoints</description>
</item>
<item>
<title>Add prior information to a data wrapper</title>
<link>/reference/dynwrap/infer_trajectory/add_prior_information/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/infer_trajectory/add_prior_information/</guid>
<description>Source: R/wrap_add_prior_information.R add_prior_information.Rd Note that the given data wrapper requires a trajectory and expression values to have been added already.
For example, what are the start cells, the end cells, to which milestone does each cell belong to, ...
add_prior_information(dataset, start_id = NULL, end_id = NULL, groups_id = NULL, groups_network = NULL, features_id = NULL, groups_n = NULL, start_n = NULL, end_n = NULL, timecourse_continuous = NULL, timecourse_discrete = NULL, verbose = TRUE) is_wrapper_with_prior_information(dataset) generate_prior_information(cell_ids, milestone_ids, milestone_network, milestone_percentages, progressions, divergence_regions, expression, feature_info = NULL, cell_info = NULL, marker_fdr = 0.</description>
</item>
<item>
<title>Add timings checkpoints</title>
<link>/reference/dynwrap/adapt_trajectory/add_timings/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/adapt_trajectory/add_timings/</guid>
<description> Source: R/wrap_add_timings.R add_timings.Rd Add timings checkpoints
Helper function for storing timings information.
add_timings(trajectory, timings) is_wrapper_with_timings(trajectory) add_timing_checkpoint(timings, name) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
timings A list of timings.
name The name of the timings checkpoint.
Contents Arguments -- </description>
</item>
<item>
<title>All allowed inputs</title>
<link>/reference/dynwrap/create_ti_method/allowed_inputs/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/allowed_inputs/</guid>
<description> Source: R/data.R allowed_inputs.Rd All allowed inputs
allowed_inputs Format An object of class tbl_df (inherits from tbl, data.frame) with 13 rows and 2 columns.
Contents Format -- </description>
</item>
<item>
<title>All allowed outputs</title>
<link>/reference/dynwrap/other/allowed_outputs/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/other/allowed_outputs/</guid>
<description> Source: R/data.R allowed_outputs.Rd All allowed outputs
allowed_outputs Format An object of class tbl_df (inherits from tbl, data.frame) with 14 rows and 5 columns.
Contents Format -- </description>
</item>
<item>
<title>An example bifurcating dataset</title>
<link>/reference/dynplot/other/example_bifurcating/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/other/example_bifurcating/</guid>
<description> example_bifurcating.Rd An example bifurcating dataset
example_bifurcating Format An object of class dynwrap::with_prior (inherits from dynwrap::with_expression, dynwrap::with_cell_waypoints, dynwrap::with_trajectory, dynwrap::data_wrapper, list) of length 18.
Contents Format -- </description>
</item>
<item>
<title>An example disconnected dataset</title>
<link>/reference/dynplot/other/example_disconnected/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/other/example_disconnected/</guid>
<description> example_disconnected.Rd An example disconnected dataset
example_disconnected Format An object of class dynwrap::with_prior (inherits from dynwrap::with_expression, dynwrap::with_cell_waypoints, dynwrap::with_trajectory, dynwrap::data_wrapper, list) of length 18.
Contents Format -- </description>
</item>
<item>
<title>An example linear dataset</title>
<link>/reference/dynplot/other/example_linear/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/other/example_linear/</guid>
<description> example_linear.Rd An example linear dataset
example_linear Format An object of class dynwrap::with_prior (inherits from dynwrap::with_expression, dynwrap::with_cell_waypoints, dynwrap::with_trajectory, dynwrap::data_wrapper, list) of length 18.
Contents Format -- </description>
</item>
<item>
<title>An example tree dataset</title>
<link>/reference/dynplot/other/example_tree/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/other/example_tree/</guid>
<description> example_tree.Rd An example tree dataset
example_tree Format An object of class dynwrap::with_prior (inherits from dynwrap::with_expression, dynwrap::with_cell_waypoints, dynwrap::with_trajectory, dynwrap::data_wrapper, list) of length 18.
Contents Format -- </description>
</item>
<item>
<title>Angle</title>
<link>/reference/dynmethods/method/ti_angle/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_angle/</guid>
<description> ti_angle.Rd Will generate a trajectory using Angle.
This method was wrapped inside a container.
ti_angle(dimred = "pca") Arguments dimred Which dimensionality reduction method to use. Domain: pca, mds, tsne, ica, lle, landmark_mds, mds_sammon, mds_isomds, mds_smacof, umap, dm_diffusionMap, dm_destiny. Default: pca. Format: character.
Value A TI method wrapper to be used together with infer_trajectory
Contents Arguments Value -- </description>
</item>
<item>
<title>CALISTA</title>
<link>/reference/dynmethods/method/ti_calista/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_calista/</guid>
<description>ti_calista.Rd Will generate a trajectory using CALISTA.
This method was wrapped inside a container. The original code of this method is available here.
ti_calista(runs = 50L, max_iter = 100L) Arguments runs Number of independent runs of greedy algorithm. Domain: U(20, 100). Default: 50. Format: integer.
max_iter Number of iterations in greedy algorithm. Domain: U(20, 400). Default: 100. Format: integer.
Value A TI method wrapper to be used together with infer_trajectory</description>
</item>
<item>
<title>Calculate geodesic distances between cells in a trajectory</title>
<link>/reference/dynwrap/derive_trajectory/calculate_geodesic_distances/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/derive_trajectory/calculate_geodesic_distances/</guid>
<description>Source: R/calculate_geodesic_distances.R calculate_geodesic_distances.Rd Will calculate geodesic distances between cells within a trajectory. To speed things up, only the distances with a set of waypoint cells are calculated.
calculate_geodesic_distances(trajectory, waypoint_cells = NULL, waypoint_milestone_percentages = NULL) compute_tented_geodesic_distances(trajectory, waypoint_cells = NULL, waypoint_milestone_percentages = NULL) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
waypoint_cells A vector of waypoint cells. Only the geodesic distances between waypoint cells and all other cells will be calculated.</description>
</item>
<item>
<title>Calculate mean values by milestone percentages</title>
<link>/reference/dynwrap/derive_trajectory/calculate_average_by_milestone_percentages/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/derive_trajectory/calculate_average_by_milestone_percentages/</guid>
<description>Source: R/calculate_average.R calculate_average_by_milestone_percentages.Rd Calculate mean values by milestone percentages
calculate_average_by_milestone_percentages(x, milestone_percentages) Arguments x A matrix. One row for every cell; one column for every feature. The rows must be named.
milestone_percentages A data frame of milestone percentages. Format: data_frame(cell_id = character(), milestone_id = character(), percentage = numeric()).
Examples data(example_dataset) calculate_average_by_milestone_percentages( x = example_dataset$expression, milestone_percentages = example_dataset$milestone_percentages )#&gt; 2 x 3 Matrix of class "</description>
</item>
<item>
<title>Calculate mean values per cell group</title>
<link>/reference/dynwrap/derive_trajectory/calculate_average_by_group/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/derive_trajectory/calculate_average_by_group/</guid>
<description>Source: R/calculate_average.R calculate_average_by_group.Rd Calculate mean values per cell group
calculate_average_by_group(x, cell_grouping) Arguments x A matrix. One row for every cell; one column for every feature. The rows must be named.
cell_grouping A data frame denoting the grouping of the cells. Format: data_frame(cell_id = character(), group_id = character()).
Examples data(example_dataset) calculate_average_by_group( x = example_dataset$expression, cell_grouping = example_dataset$prior_information$groups_id )#&gt; 2 x 3 Matrix of class "</description>
</item>
<item>
<title>Calculate the similarity between two trajectory models.</title>
<link>/reference/dyneval/metric/calculate_metrics/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dyneval/metric/calculate_metrics/</guid>
<description>calculate_metrics.Rd One use case for these metrics is to calculate the accuracy of a certain prediction compared to a reference trajectory. However, these metrics can also be used for other purposes, such as clustering of trajectories.
calculate_metrics(dataset, model, metrics = dyneval::metrics$metric_id, expression_source = dataset$expression) Arguments dataset The first trajectory, in most cases a gold standard trajectory
model The second trajectory, in most cases a predicted trajectory</description>
</item>
<item>
<title>CellRouter</title>
<link>/reference/dynmethods/method/ti_cellrouter/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_cellrouter/</guid>
<description>ti_cellrouter.Rd Will generate a trajectory using CellRouter.
This method was wrapped inside a container. The original code of this method is available here.
ti_cellrouter(ndim_pca = 20L, ndim_tsne = 11L, max_iter = 1000L, cluster_method = "graph.clustering", k_clustering = 20L, ndim_pca_clustering = 20L, k_knn = 10L, ndim_pca_knn = 20L, sim_type = "jaccard", distance_method_paths = "graph", ranks = "rank", num_cells = 3L, neighs = 3L, perplexity = 30L) Arguments ndim_pca Number of principal components to compute.</description>
</item>
<item>
<title>CellTrails</title>
<link>/reference/dynmethods/method/ti_celltrails/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_celltrails/</guid>
<description>ti_celltrails.Rd Will generate a trajectory using CellTrails.
This method was wrapped inside a container. The original code of this method is available here.
ti_celltrails(filter_features = FALSE, threshold_dl = 2L, threshold_cov = 0.05, threshold_ff = 1.7, min_expr = 0L, frac = 100L, min_size = 0.01, min_feat = 5L, max_pval = 1e-04, min_fc = 2L, l = 10L) Arguments filter_features Whether to include celltrails feature filtering. Default: FALSE.</description>
</item>
<item>
<title>Classify a milestone network</title>
<link>/reference/dynwrap/other/classify_milestone_network/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/other/classify_milestone_network/</guid>
<description> Source: R/classify_milestone_network.R classify_milestone_network.Rd Classify a milestone network
classify_milestone_network(milestone_network) Arguments milestone_network A milestone network
Contents Arguments -- </description>
</item>
<item>
<title>Color cells using a background density</title>
<link>/reference/dynplot/other/add_density_coloring/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/other/add_density_coloring/</guid>
<description>add_density_coloring.Rd Color cells using a background density
add_density_coloring(cell_positions, color_density = c("none", "grouping", "feature"), trajectory, grouping = NULL, groups = NULL, feature_oi = NULL, expression_source = "expression", padding = 0.1, nbins = 1000, bw = 0.2, density_cutoff = 0.3, density_cutoff_label = density_cutoff/10) Arguments cell_positions The positions of the cells in 2D
color_density How to color density, can be "none", "grouping", or "feature"
trajectory The trajectory</description>
</item>
<item>
<title>Compare enrichment in finding back the most important genes</title>
<link>/reference/dyneval/metric/calculate_featureimp_enrichment/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dyneval/metric/calculate_featureimp_enrichment/</guid>
<description>calculate_featureimp_enrichment.Rd Compare enrichment in finding back the most important genes
calculate_featureimp_enrichment(dataset, prediction, expression_source = dataset$expression, fi_method = dynfeature::fi_ranger_rf_lite()) Arguments dataset A dataset
prediction A predicted trajectory
expression_source The expression data matrix, with features as columns.
If a matrix is provided, it is used as is.
If a character is provided, dataset[[expression_source]] should contain the matrix.
If a function is provided, that function will be called in order to obtain the expression (useful for lazy loading).</description>
</item>
<item>
<title>Compare feature importances derived by both trajectories</title>
<link>/reference/dyneval/metric/calculate_featureimp_cor/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dyneval/metric/calculate_featureimp_cor/</guid>
<description>calculate_featureimp_cor.Rd Compare feature importances derived by both trajectories
calculate_featureimp_cor(dataset, prediction, expression_source = dataset$expression_source, fi_method = dynfeature::fi_ranger_rf_lite()) Arguments dataset A dataset
prediction A predicted trajectory
expression_source The expression data matrix, with features as columns.
If a matrix is provided, it is used as is.
If a character is provided, dataset[[expression_source]] should contain the matrix.
If a function is provided, that function will be called in order to obtain the expression (useful for lazy loading).</description>
</item>
<item>
<title>Compares the mapping between milestones or branches</title>
<link>/reference/dyneval/metric/calculate_mapping/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dyneval/metric/calculate_mapping/</guid>
<description> calculate_mapping.Rd Compares the mapping between milestones or branches
calculate_mapping(dataset, prediction, grouping = c("branches", "milestones"), simplify = TRUE) calculate_mapping_milestones(dataset, prediction, simplify = TRUE) calculate_mapping_branches(dataset, prediction, simplify = TRUE) Arguments dataset A dataset
prediction A predicted model
grouping How to group the cells, either branches or milestones
simplify Whether to simplify the trajectory (allowing self loops)
Contents Arguments -- </description>
</item>
<item>
<title>Component 1</title>
<link>/reference/dynmethods/method/ti_comp1/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_comp1/</guid>
<description>ti_comp1.Rd Will generate a trajectory using Component 1.
This method was wrapped inside a container.
ti_comp1(dimred = "pca", ndim = 2L, component = 1L) Arguments dimred Which dimensionality reduction method to use. Domain: pca, mds, tsne, ica, lle, landmark_mds, mds_sammon, mds_isomds, mds_smacof, umap, dm_diffusionMap. Default: pca. Format: character.
ndim . Domain: U(2, 30). Default: 2. Format: integer.
component . Domain: U(1, 10).</description>
</item>
<item>
<title>Compute metrics related to the prediction of the positions</title>
<link>/reference/dyneval/metric/calculate_position_predict/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dyneval/metric/calculate_position_predict/</guid>
<description> calculate_position_predict.Rd Compute metrics related to the prediction of the positions
calculate_position_predict(dataset, prediction, metrics = c("rf_mse", "rf_rsq", "lm_mse", "lm_rsq")) Arguments dataset A dataset containing a trajectory
prediction A predicted trajectory
metrics Which metrics to predict, can be rf_mse, rf_rsq, rf_nmse, lm_mse, lm_rsq and/or lm_nmse
Contents Arguments -- </description>
</item>
<item>
<title>Constructs a circular trajectory using the pseudotime values of each cell.</title>
<link>/reference/dynwrap/create_trajectory/add_cyclic_trajectory/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/add_cyclic_trajectory/</guid>
<description>Source: R/wrap_add_cyclic_trajectory.R add_cyclic_trajectory.Rd This function will generate the milestone_network and progressions.
add_cyclic_trajectory(dataset, pseudotime, directed = FALSE, do_scale_minmax = TRUE, ...) Arguments dataset A dataset created by wrap_data() or wrap_expression()
pseudotime A named vector of pseudo times.
directed Whether or not the directionality of the pseudotime is predicted.
do_scale_minmax Whether or not to scale the pseudotime between 0 and 1.</description>
</item>
<item>
<title>Constructs a linear trajectory using the pseudotime values of each cell.</title>
<link>/reference/dynwrap/create_trajectory/add_linear_trajectory/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/add_linear_trajectory/</guid>
<description>Source: R/wrap_add_linear_trajectory.R add_linear_trajectory.Rd This function will generate the milestone_network and progressions.
add_linear_trajectory(dataset, pseudotime, directed = FALSE, do_scale_minmax = TRUE, ...) Arguments dataset A dataset created by wrap_data() or wrap_expression()
pseudotime A named vector of pseudo times.
directed Whether or not the directionality of the pseudotime is predicted.
do_scale_minmax Whether or not to scale the pseudotime between 0 and 1.</description>
</item>
<item>
<title>Constructs a trajectory by projecting cells within a dimensionality reduction onto a backbone formed by a milestone network. Optionally, a cell grouping can be given which will restrict the edges on which a cell can be projected.</title>
<link>/reference/dynwrap/create_trajectory/add_dimred_projection/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/add_dimred_projection/</guid>
<description>Source: R/wrap_add_dimred_projection.R add_dimred_projection.Rd This function will generate the milestone_network and progressions.
add_dimred_projection(dataset, milestone_ids = NULL, milestone_network, dimred, dimred_milestones, grouping = NULL, ...) Arguments dataset A dataset created by wrap_data() or wrap_expression()
milestone_ids The ids of the milestones in the trajectory. Type: Character vector.
milestone_network The network of the milestones. Type: Data frame(from = character, to = character, length = numeric, directed = logical).</description>
</item>
<item>
<title>Constructs a trajectory using a cell grouping and a network between groups. Will use an existing grouping if it is present in the dataset.</title>
<link>/reference/dynwrap/create_trajectory/add_cluster_graph/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/add_cluster_graph/</guid>
<description>Source: R/wrap_add_cluster_graph.R add_cluster_graph.Rd This function will generate the milestone_network and progressions.
add_cluster_graph(dataset, milestone_network, grouping = NULL, explicit_splits = FALSE, ...) Arguments dataset A dataset created by wrap_data() or wrap_expression()
milestone_network A network of milestones.
grouping A grouping of the cells, can be a named vector or a dataframe with group_id (character) and cell_id (character)
explicit_splits Whether to make splits specific by adding a starting node.</description>
</item>
<item>
<title>Constructs a trajectory using a graph between cells, by mapping cells onto a set of backbone cells.</title>
<link>/reference/dynwrap/create_trajectory/add_cell_graph/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/add_cell_graph/</guid>
<description>Source: R/wrap_add_cell_graph.R add_cell_graph.Rd This function will generate the milestone_network and progressions.
add_cell_graph(dataset, cell_graph, to_keep, milestone_prefix = "milestone_", ...) Arguments dataset A dataset created by wrap_data() or wrap_expression()
cell_graph The edges between cells. Format: Data frame(from = character, to = character, length(optional) = numeric, directed(optional) = logical)
to_keep A character vector with the identifiers of the backbone cells. Alternatively, a named boolean vector whether a cell is from the backbone</description>
</item>
<item>
<title>Contributing</title>
<link>/about/contributing/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/about/contributing/</guid>
<description>We welcome any contributions to this project, be it changes in documentation, bug fixes, new functionality, or even new packages if they fit the scope of our project. When making big changes, please first discuss the change you wish to make via issue, email, or any other method with the owners of the repository.
Pull Requests Make sure your code is following tidyverse style guide Ensure that you are working in the devel branch (or any derivates of the devel branch) Edit the NEWS.</description>
</item>
<item>
<title>Convert a definition loaded in from a yaml</title>
<link>/reference/dynwrap/create_ti_method/convert_definition/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/convert_definition/</guid>
<description> Source: R/method_process_definition.R convert_definition.Rd Convert a definition loaded in from a yaml
convert_definition(definition_raw) Arguments definition_raw The raw definition loaded from the yaml
Contents Arguments -- </description>
</item>
<item>
<title>Convert milestone percentages to progressions</title>
<link>/reference/dynwrap/other/convert_milestone_percentages_to_progressions/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/other/convert_milestone_percentages_to_progressions/</guid>
<description> Source: R/convert_milestone_percentages_to_progressions.R convert_milestone_percentages_to_progressions.Rd Convert milestone percentages to progressions
convert_milestone_percentages_to_progressions(cell_ids, milestone_ids, milestone_network, milestone_percentages) Arguments cell_ids Vector of all cell ids
milestone_ids Vector of milestone ids
milestone_network Milestone network
milestone_percentages Milestone percentages
Contents Arguments -- </description>
</item>
<item>
<title>Convert progressions to milestone percentages</title>
<link>/reference/dynwrap/other/convert_progressions_to_milestone_percentages/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/other/convert_progressions_to_milestone_percentages/</guid>
<description> Source: R/convert_progressions_to_milestone_percentages.R convert_progressions_to_milestone_percentages.Rd Convert progressions to milestone percentages
convert_progressions_to_milestone_percentages(cell_ids, milestone_ids, milestone_network, progressions) Arguments cell_ids Vector of all cell ids
milestone_ids Vector of milestone ids
milestone_network Milestone network
progressions Progressions dataframe
Contents Arguments -- </description>
</item>
<item>
<title>Create a TI method from a docker / singularity container</title>
<link>/reference/dynwrap/create_ti_method/create_ti_method_container/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/create_ti_method_container/</guid>
<description>Source: R/method_create_ti_method_container.R create_ti_method_container.Rd These functions create a TI method from a container using babelwhale. Supports both docker and singularity as a backend.
create_ti_method_container(container_id, pull_if_needed = TRUE, return_function = TRUE) Arguments container_id The name of the container repository (e.g. "dynverse/ti_angle").
pull_if_needed Pull the container if not yet available.
return_function Whether to return a function that allows you to override the default parameters, or just return the method meta data as is.</description>
</item>
<item>
<title>Create a TI method from a local method definition file</title>
<link>/reference/dynwrap/create_ti_method/create_ti_method_definition/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/create_ti_method_definition/</guid>
<description>Source: R/method_create_ti_method_definition.R create_ti_method_definition.Rd The local method definition file describes a method that is runnable on the local system.
create_ti_method_definition(definition, script, return_function = TRUE) Arguments definition A definition, see definition()
script Location of the script that will be executed. Has to contain a #!
return_function Whether to return a function that allows you to override the default parameters, or just return the method meta data as is.</description>
</item>
<item>
<title>Create a TI method wrapper</title>
<link>/reference/dynwrap/create_ti_method/create_ti_method_r/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/create_ti_method_r/</guid>
<description>Source: R/method_create_ti_method_r.R create_ti_method_r.Rd Create a TI method wrapper
create_ti_method_r(definition, run_fun, package_required = character(), package_loaded = character(), remotes_package = character(), return_function = TRUE) Arguments definition A definition, see definition()
run_fun A function to infer a trajectory, with parameters counts/expression, parameters, priors, verbose and seed
package_required The packages that need to be installed before executing the method.
package_loaded The packages that need to be loaded before executing the method.</description>
</item>
<item>
<title>Create a definition</title>
<link>/reference/dynwrap/create_ti_method/definition/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/definition/</guid>
<description>Source: R/method_process_definition.R definition.Rd A definition contains meta information on a TI method and various aspects thereof. For brevity, the example only contains a minimum example, check the documentation of the def_* helper functions for more extensive examples.
definition(method, wrapper, manuscript = NULL, container = NULL, parameters = parameter_set()) is_ti_method(method) Arguments method Meta information on the TI method (see def_method()).
wrapper Meta information on the wrapper itself (see def_wrapper()).</description>
</item>
<item>
<title>Create a grouping from a trajectory</title>
<link>/reference/dynwrap/derive_trajectory/group_from_trajectory/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/derive_trajectory/group_from_trajectory/</guid>
<description> Source: R/wrap_add_grouping.R group_from_trajectory.Rd Grouping cells onto their edges, or grouping cells onto their nearest milestones
group_onto_trajectory_edges(trajectory, group_template = "{from}-&gt;{to}") group_onto_nearest_milestones(trajectory) Arguments trajectory The trajectory as created by infer_trajectory() or add_trajectory()
group_template Processed by glue::glue to name the group
Contents Arguments -- </description>
</item>
<item>
<title>Create a trajectory given its branch network and the pseudotime of the cells on one of the branches</title>
<link>/reference/dynwrap/create_trajectory/add_branch_trajectory/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/add_branch_trajectory/</guid>
<description>Source: R/wrap_add_branch_trajectory.R add_branch_trajectory.Rd Create a trajectory given its branch network and the pseudotime of the cells on one of the branches
add_branch_trajectory(dataset, branch_network, branches, branch_progressions, ...) Arguments dataset A dataset created by wrap_data() or wrap_expression()
branch_network The network between branches Type: Data frame(from = charactor, to = character)
branches The length and directedness of the branches Type: Data frame(branch_id = character, length = numeric, directed = logical)</description>
</item>
<item>
<title>Create a wrapper object with expression and counts</title>
<link>/reference/dynwrap/infer_trajectory/wrap_expression/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/infer_trajectory/wrap_expression/</guid>
<description>Source: R/wrap_add_expression.R wrap_expression.Rd Create a wrapper object with expression and counts
wrap_expression(id = NULL, expression, counts, cell_info = NULL, feature_info = NULL, ...) Arguments id A unique identifier for the data. If NULL, a random string will be generated.
expression The normalised expression values with genes in columns and cells in rows
counts The counts with genes in columns and cells in rows</description>
</item>
<item>
<title>Create an empty plot for spacing</title>
<link>/reference/dynplot/plot_helpers/empty_plot/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/plot_helpers/empty_plot/</guid>
<description> empty_plot.Rd Create an empty plot for spacing
empty_plot() Contents -- </description>
</item>
<item>
<title>DPT</title>
<link>/reference/dynmethods/method/ti_dpt/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_dpt/</guid>
<description>ti_dpt.Rd Will generate a trajectory using DPT.
This method was wrapped inside a container. The original code of this method is available here.
ti_dpt(sigma = "local", distance = "euclidean", ndim = 20L, density_norm = TRUE, n_local = c(5L, 7L), w_width = 0.1) Arguments sigma Diffusion scale parameter of the Gaussian kernel. A larger sigma might be necessary if the eigenvalues can not be found because of a singularity in the matrix.</description>
</item>
<item>
<title>Default theme for TI plots</title>
<link>/reference/dynplot/plot_helpers/process_dynplot/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynplot/plot_helpers/process_dynplot/</guid>
<description> process_dynplot.Rd Default theme for TI plots
process_dynplot(g, id = NULL, expand = TRUE) Arguments g A ggplot to modify
id The title
expand Whether or not to leave space at the borders
Contents Arguments -- </description>
</item>
<item>
<title>Define a trajectory dataset given its milestone network and milestone percentages or progressions</title>
<link>/reference/dynwrap/create_trajectory/add_trajectory/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_trajectory/add_trajectory/</guid>
<description>Source: R/wrap_add_trajectory.R add_trajectory.Rd Define a trajectory dataset given its milestone network and milestone percentages or progressions
add_trajectory(dataset, milestone_ids = NULL, milestone_network, divergence_regions = NULL, milestone_percentages = NULL, progressions = NULL, allow_self_loops = FALSE, ...) is_wrapper_with_trajectory(trajectory) Arguments dataset A dataset created by wrap_data() or wrap_expression()
milestone_ids The ids of the milestones in the trajectory. Type: Character vector.
milestone_network The network of the milestones.</description>
</item>
<item>
<title>Define meta information on the TI method.</title>
<link>/reference/dynwrap/create_ti_method/def_method/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/create_ti_method/def_method/</guid>
<description>Source: R/method_process_definition.R def_method.Rd Define meta information on the TI method.
def_method(id, name = id, source = "tool", tool_id = NULL, platform = NULL, url = NULL, license = NULL, authors = list(), description = NULL) Arguments id An id by which to identify a method. Should only contain lowercase letters or underscores.
name The name of the method.
source The type of TI method.</description>
</item>
<item>
<title>Determine the positions of all cells in the trajectory</title>
<link>/reference/dynwrap/other/determine_cell_trajectory_positions/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/other/determine_cell_trajectory_positions/</guid>
<description>Source: R/wrap_add_cell_waypoints.R determine_cell_trajectory_positions.Rd Determine the positions of all cells in the trajectory
determine_cell_trajectory_positions(milestone_ids, milestone_network, milestone_percentages, progressions, divergence_regions) Arguments milestone_ids The ids of the milestones in the trajectory. Type: Character vector.
milestone_network The network of the milestones. Type: Data frame(from = character, to = character, length = numeric, directed = logical).
milestone_percentages A data frame specifying what percentage milestone each cell consists of.</description>
</item>
<item>
<title>Edge flip score</title>
<link>/reference/dyneval/metric/calculate_edge_flip/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dyneval/metric/calculate_edge_flip/</guid>
<description>calculate_edge_flip.Rd Edge flip score
calculate_edge_flip(net1, net2, return = c("score", "all"), simplify = TRUE, limit_flips = 5, limit_combinations = choose(25, 4)) Arguments net1 Network 1
net2 Network 2
return Whether to return only the score or the full output (all)
simplify Whether or not to simplify the networks
limit_flips Maximal number of flips to check</description>
</item>
<item>
<title>ElPiGraph</title>
<link>/reference/dynmethods/method/ti_elpigraph/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_elpigraph/</guid>
<description>ti_elpigraph.Rd Will generate a trajectory using ElPiGraph.
This method was wrapped inside a container. The original code of this method is available here.
ti_elpigraph(topology = "tree", NumNodes = 50L, NumEdges = 100000L, InitNodes = 2L, Mu = 0.1, Lambda = 0.01, MaxNumberOfIterations = 10L, eps = 0.01, CenterData = FALSE) Arguments topology The kind of topology to detect. Domain: cycle, tree, linear. Default: tree. Format: character.</description>
</item>
<item>
<title>ElPiGraph - Cycle</title>
<link>/reference/dynmethods/method/ti_elpicycle/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_elpicycle/</guid>
<description>ti_elpicycle.Rd Will generate a trajectory using ElPiGraph - Cycle.
This method was wrapped inside a container. The original code of this method is available here.
ti_elpicycle(NumNodes = 50L, NumEdges = 100000L, InitNodes = 2L, Mu = 0.1, Lambda = 0.01, MaxNumberOfIterations = 10L, eps = 0.01, CenterData = FALSE) Arguments NumNodes The number of nodes of the principal graph. Domain: U(2, 1000). Default: 50. Format: integer.</description>
</item>
<item>
<title>ElPiGraph - Linear</title>
<link>/reference/dynmethods/method/ti_elpilinear/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_elpilinear/</guid>
<description>ti_elpilinear.Rd Will generate a trajectory using ElPiGraph - Linear.
This method was wrapped inside a container. The original code of this method is available here.
ti_elpilinear(NumNodes = 50L, NumEdges = 100000L, InitNodes = 2L, Mu = 0.1, Lambda = 0.01, MaxNumberOfIterations = 10L, eps = 0.01, CenterData = FALSE) Arguments NumNodes The number of nodes of the principal graph. Domain: U(2, 1000). Default: 50. Format: integer.</description>
</item>
<item>
<title>Embeddr</title>
<link>/reference/dynmethods/method/ti_embeddr/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_embeddr/</guid>
<description>ti_embeddr.Rd Will generate a trajectory using Embeddr.
This method was wrapped inside a container. The original code of this method is available here.
ti_embeddr(ndim = 2L, kernel = "nn", metric = "correlation", nn_pct = 0L, eps = 0L, t = 0L, symmetrize = "mean", measure_type = "unorm", thresh = 0.001, maxit = 10L, stretch = 2L, smoother = "smooth.spline") Arguments ndim Dimension of the embedded space, default is 2.</description>
</item>
<item>
<title>Error</title>
<link>/reference/dynmethods/method/ti_error/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_error/</guid>
<description> ti_error.Rd Will generate a trajectory using Error.
This method was wrapped inside a container.
ti_error(dummy_param = 0.5) Arguments dummy_param Dummy parameter. Domain: U(0, 1). Default: 0.5. Format: numeric.
Value A TI method wrapper to be used together with infer_trajectory
Contents Arguments Value -- </description>
</item>
<item>
<title>Evaluating trajectory inference methods</title>
<link>/reference/dyneval/other/dyneval/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dyneval/other/dyneval/</guid>
<description> dyneval.Rd Evaluating trajectory inference methods
Contents -- </description>
</item>
<item>
<title>Example dataset</title>
<link>/reference/dynwrap/other/example_dataset/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/other/example_dataset/</guid>
<description> Source: R/data.R example_dataset.Rd Example dataset
example_dataset Format An object of class dynwrap::with_cell_waypoints (inherits from dynwrap::with_prior, dynwrap::with_dimred, dynwrap::with_trajectory, dynwrap::with_expression, dynwrap::data_wrapper, list) of length 20.
Contents Format -- </description>
</item>
<item>
<title>FORKS</title>
<link>/reference/dynmethods/method/ti_forks/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_forks/</guid>
<description>ti_forks.Rd Will generate a trajectory using FORKS.
This method was wrapped inside a container. The original code of this method is available here.
ti_forks(norm_function = "median", norm_quantile = 75L, cum_sum_exp_var = 0.9, cluster = c(4L, 10L), mapping_type = "Isomap", initialization = "kmeans", iterMax = 1000L, eta = 0.01, C = 1L) Arguments norm_function No description provided by the author. Domain: mean, median, quantile. Default: median. Format: character.</description>
</item>
<item>
<title>FateID</title>
<link>/reference/dynmethods/method/ti_fateid/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_fateid/</guid>
<description>ti_fateid.Rd Will generate a trajectory using FateID.
This method was wrapped inside a container. The original code of this method is available here.
ti_fateid(reclassify = TRUE, clthr = 0.9, nbfactor = 5L, q = 0.75, k = 3L, m = "tsne", minnr = 5L, minnrh = 10L, trthr = 0.4, force = FALSE) Arguments reclassify Whether to reclassify the cell grouping. Default: TRUE. Format: logical.</description>
</item>
<item>
<title>GNG</title>
<link>/reference/dynmethods/method/ti_gng/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_gng/</guid>
<description>ti_gng.Rd Will generate a trajectory using GNG.
This method was wrapped inside a container. The original code of this method is available here.
ti_gng(dimred = "landmark_mds", ndim = 5L, max_iter = 15000L, max_nodes = 8L, apply_mst = TRUE) Arguments dimred Which dimensionality reduction method to use. Domain: pca, mds, tsne, ica, lle, landmark_mds, mds_sammon, mds_isomds, mds_smacof, umap, dm_diffusionMap. Default: landmark_mds. Format: character.
ndim The number of dimensions.</description>
</item>
<item>
<title>GPfates</title>
<link>/reference/dynmethods/method/ti_gpfates/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynmethods/method/ti_gpfates/</guid>
<description>ti_gpfates.Rd Will generate a trajectory using GPfates.
This method was wrapped inside a container. The original code of this method is available here.
ti_gpfates(log_expression_cutoff = 0.5, min_cells_expression_cutoff = 0L, ndim = 2L) Arguments log_expression_cutoff The log expression cutoff. Domain: U(0.5, 5). Default: 0.5. Format: numeric.
min_cells_expression_cutoff The min expression cutoff. Domain: U(0, 20). Default: 0. Format: numeric.
ndim Number of dimensions for dimensionality reduction.</description>
</item>
<item>
<title>Generate a random seed</title>
<link>/reference/dynwrap/other/random_seed/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>/reference/dynwrap/other/random_seed/</guid>
<description> Source: R/method_infer_trajectory.R random_seed.Rd ... From the current seed.