/
as.Seurat.html
255 lines (203 loc) · 12.5 KB
/
as.Seurat.html
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
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Convert objects to Seurat objects — as.Seurat.liger • scCustomize</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/flatly/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Convert objects to Seurat objects — as.Seurat.liger"><meta property="og:description" content="Merges raw.data and scale.data of object, and creates Seurat object with these values along with slots
containing dimensionality reduction coordinates, iNMF factorization, and cluster assignments.
Supports Seurat V3/4 and V4."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">scCustomize</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">2.1.2</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="../index.html">Getting Started</a>
</li>
<li>
<a href="../articles/Installation.html">Install</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Vignettes
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu"><li class="dropdown-header">Plotting Vignettes</li>
<li>
<a href="../articles/Gene_Expression_Plotting.html">Plotting #1: General Analysis Plots</a>
</li>
<li>
<a href="../articles/QC_Plots.html">Plotting #2: QC Plots</a>
</li>
<li>
<a href="../articles/Sequencing_QC_Plots.html">Plotting #3: Sequencing QC Plots/Analysis</a>
</li>
<li>
<a href="../articles/Iterative_Plotting.html">Plotting #4: Iterative Plotting Functions</a>
</li>
<li>
<a href="../articles/Color_Palettes.html">Customized Color Palettes & Themes</a>
</li>
<li class="divider">
<li class="dropdown-header">Helpers & Utilities</li>
<li>
<a href="../articles/Helpers_and_Utilities.html">General Helpers & Utilities</a>
</li>
<li>
<a href="../articles/Read_and_Write_Functions.html">Read & Write Data Functions</a>
</li>
<li>
<a href="../articles/Object_Conversion.html">Object/Assay Format Conversion</a>
</li>
<li>
<a href="../articles/Markers_and_Cluster_Annotation.html">Marker Identification & Cluster Annotation Helpers</a>
</li>
<li>
<a href="../articles/Statistics.html">Statistics Functions</a>
</li>
<li>
<a href="../articles/Update_Gene_Symbols.html">Updating Gene Symbols</a>
</li>
<li>
<a href="../articles/Misc_Functions.html">Misc Functions</a>
</li>
<li class="divider">
<li class="dropdown-header">Other Package Interactivity/Functions</li>
<li>
<a href="../articles/LIGER_Functions.html">LIGER Plotting & Functionality</a>
</li>
<li>
<a href="../articles/Cell_Bender_Functions.html">Cell Bender Functionality & Plotting</a>
</li>
</ul></li>
<li>
<a href="../news/index.html">News/Changelog</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li>
<a href="../articles/FAQ.html">FAQ</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://github.com/samuel-marsh/scCustomize/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Convert objects to <code>Seurat</code> objects</h1>
<small class="dont-index">Source: <a href="https://github.com/samuel-marsh/scCustomize/blob/HEAD/R/Object_Conversion.R" class="external-link"><code>R/Object_Conversion.R</code></a></small>
<div class="hidden name"><code>as.Seurat.Rd</code></div>
</div>
<div class="ref-description">
<p>Merges raw.data and scale.data of object, and creates Seurat object with these values along with slots
containing dimensionality reduction coordinates, iNMF factorization, and cluster assignments.
Supports Seurat V3/4 and V4.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for liger</span></span>
<span><span class="fu"><a href="https://rdrr.io/pkg/SeuratObject/man/as.Seurat.html" class="external-link">as.Seurat</a></span><span class="op">(</span></span>
<span> <span class="va">x</span>,</span>
<span> nms <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">x</span><span class="op">@</span><span class="va">H</span><span class="op">)</span>,</span>
<span> renormalize <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span> use.liger.genes <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span> by.dataset <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> keep_meta <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span> reduction_label <span class="op">=</span> <span class="st">"UMAP"</span>,</span>
<span> seurat_assay <span class="op">=</span> <span class="st">"RNA"</span>,</span>
<span> assay_type <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> add_barcode_names <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> barcode_prefix <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span> barcode_cell_id_delimiter <span class="op">=</span> <span class="st">"_"</span>,</span>
<span> <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>x</dt>
<dd><p><code>liger</code> object.</p></dd>
<dt>nms</dt>
<dd><p>By default, labels cell names with dataset of origin (this is to account for cells in
different datasets which may have same name). Other names can be passed here as vector, must have
same length as the number of datasets. (default names(H)).</p></dd>
<dt>renormalize</dt>
<dd><p>Whether to log-normalize raw data using Seurat defaults (default TRUE).</p></dd>
<dt>use.liger.genes</dt>
<dd><p>Whether to carry over variable genes (default TRUE).</p></dd>
<dt>by.dataset</dt>
<dd><p>Include dataset of origin in cluster identity in Seurat object (default FALSE).</p></dd>
<dt>keep_meta</dt>
<dd><p>logical. Whether to transfer additional metadata (nGene/nUMI/dataset already transferred)
to new Seurat Object. Default is TRUE.</p></dd>
<dt>reduction_label</dt>
<dd><p>Name of dimensionality reduction technique used. Enables accurate transfer
or name to Seurat object instead of defaulting to "tSNE".</p></dd>
<dt>seurat_assay</dt>
<dd><p>Name to set for assay in Seurat Object. Default is "RNA".</p></dd>
<dt>assay_type</dt>
<dd><p>what type of Seurat assay to create in new object (Assay vs Assay5).
Default is NULL which will default to the current user settings.
See <code><a href="Convert_Assay.html">Convert_Assay</a></code> parameter <code>convert_to</code> for acceptable values.</p></dd>
<dt>add_barcode_names</dt>
<dd><p>logical, whether to add dataset names to the cell barcodes when
creating Seurat object, default is FALSE.</p></dd>
<dt>barcode_prefix</dt>
<dd><p>logical, if <code>add_barcode_names = TRUE</code> should the names be added as
prefix to current cell barcodes/names or a suffix (default is TRUE; prefix).</p></dd>
<dt>barcode_cell_id_delimiter</dt>
<dd><p>The delimiter to use when adding dataset id to barcode
prefix/suffix. Default is "_".</p></dd>
<dt>...</dt>
<dd><p>unused.</p></dd>
</dl></div>
<div id="value">
<h2>Value</h2>
<p>Seurat object with raw.data, scale.data, reduction_label, iNMF, and ident slots set.</p>
<p>Seurat object.</p>
</div>
<div id="details">
<h2>Details</h2>
<p>Stores original dataset identity by default in new object metadata if dataset names are passed
in nms. iNMF factorization is stored in dim.reduction object with key "iNMF".</p>
</div>
<div id="references">
<h2>References</h2>
<p>Original function is part of LIGER package <a href="https://github.com/welch-lab/liger" class="external-link">https://github.com/welch-lab/liger</a> (Licence: GPL-3).
Function was modified for use in scCustomize with additional parameters/functionality.</p>
</div>
<div id="ref-examples">
<h2>Examples</h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span>
<span class="r-in"><span><span class="va">seurat_object</span> <span class="op"><-</span> <span class="fu"><a href="https://rdrr.io/pkg/SeuratObject/man/as.Seurat.html" class="external-link">as.Seurat</a></span><span class="op">(</span>x <span class="op">=</span> <span class="va">liger_object</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Samuel Marsh.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
</footer></div>
</body></html>