Tangram算法
用途
使用Tangram做细胞注释
运行方式
SDAS cellAnnotation tangram -i st.h5ad -o outdir --reference sc.h5ad --bin_size 20 --label_key annotation2 \
--filter_rare_cell 0
输入参数说明
参数 | 是否必须 | 默认值 | 描述 |
---|---|---|---|
-i / --input | 是 | Stereo-seq h5ad,要求有原始表达矩阵 | |
-o / --output | 是 | 输出文件夹 | |
--reference | 是 | 单细胞ref h5ad,要求有原始表达矩阵 | |
--label_key | 是 | 单细胞ref h5ad.obs中表示细胞类型的列的名称 | |
--bin_size | 是 | Bin大小,用于控制图中点的大小,不用于计算,比如20,50,100, cellbin (等效于20) | |
--input_layer | 否 | Stereo-seq h5ad存放raw counts的layer | |
--ref_layer | 否 | 单细胞ref h5ad存放raw counts的layer | |
--input_gene_symbol_key | 否 | real_gene_name | Stereo-seq h5ad.var中表示基因名(symbol)的列的名称 |
--ref_gene_symbol_key | 否 | _index | 单细胞ref h5ad.var中表示基因名(symbol)的列的名称 (_index 表示使用h5ad.var.index) |
--slice_key | 否 | sampleID | 多片h5ad.obs中表示片编号的列的名称,用于画图 |
--filter_rare_cell | 否 | 100 | 如果某些细胞类型在单细胞ref中细胞数小于此值,则过滤掉这些细胞类型 |
--max_epochs | 否 | 1000 | 模型训练epoch数 |
--top_markers | 否 | 200 | 用于Tangram计算的每个细胞类型的marker基因数量 |
--seed | 否 | 42 | 随机种子设置 |
--gpu_id | 否 | -1 | 使用的GPU的编号,如果为-1,则使用CPU |
--n_threads | 否 | CPU模式下使用的线程数,默认为全部CPU |
输出结果展示
结果文件 | 描述 |
---|---|
<input_name>_anno_tangram.csv |
每个spot的注释结果,包括每种细胞类型的分数 |
<input_name>_anno_tangram.h5ad |
输入h5ad+注释结果。每个细胞类型的分数存在obsm['anno_score_tangram']中,分数最高的类型存在obs['anno_tangram']中 |
<input_name>_anno_tangram.png/pdf |
总体注释结果图,多片情况下每片画一张图,同时输出png和pdf |
<input_name>_anno_tangram_split.png/pdf |
每个细胞类型分开展示图,多片情况下每片画一张图,同时输出png和pdf |
<input_name>_anno_score_tangram.png/pdf |
每个细胞类型的分数图,多片情况下每片画一张图,同时输出png和pdf |
详细说明与具体结果展示可参考以下链接。(cell2location算法-->细胞注释-->输出结果展示)。