因為Garnett 建立在 Monocle(http://cole-trapnell-lab.github.io/monocle-release)上,所以Garnett 的數據保存在CellDataSet (CDS)類的對象中。這個類派生自Bioconductor ExpressionSet類,它為那些分析過生物微陣列實驗的人提供了一個常見的接口。Monocle提供了關於如何生成輸入cds的詳細文檔here(http://cole-trapnell-lab.github.io/monocle-release/docs/#the-celldataset-clas)。
例如,Garnett包含一個來自PBMC 10x V1表達式數據的小數據集.
1library(monocle3)
2library(garnett)
3# load in the data
4# NOTE: the 'system.file' file name is only necessary to read in
5# included package data
6#
7mat <- Matrix::readMM(system.file("extdata", "exprs_sparse.mtx", package = "garnett"))
8fdata <- read.table(system.file("extdata", "fdata.txt", package = "garnett"))
9pdata <- read.table(system.file("extdata", "pdata.txt", package = "garnett"),
10 sep="\t")
11row.names(mat) <- row.names(fdata)
12colnames(mat) <- row.names(pdata)
13
14# create a new CDS object
15#pd <- new("AnnotatedDataFrame", data = pdata)
16#fd <- new("AnnotatedDataFrame", data = fdata)
17pbmc_cds <- new_cell_data_set(as(as.matrix(mat), 'sparseMatrix'),
18 cell_metadata = pdata,
19 gene_metadata = fdata)
20
21# generate size factors for normalization later
22#pbmc_cds <- estimateSizeFactors(pbmc_cds)#
23
24pbmc_cds = preprocess_cds(pbmc_cds, num_dim = 100)
除了表達數據之外,您需要的第二個主要輸入是一個標記文件(marker file)。標記文件包含以易於閱讀的文本格式編寫的單元類型定義列表。細胞類型定義告訴Garnett如何選擇細胞來訓練模型。每個細胞類型定義以「>」符號和細胞類型名稱開頭,後面是一系列帶有定義信息的行。定義行以關鍵字和':'開頭,條目用逗號分隔。
一個簡單有效的例子:
1>B cells
2expressed: CD19, MS4A1
3
4>T cells
5expressed: CD3D
有幾種方法可以在Garnett標記文件格式中定義細胞類型。通常,每個細胞的定義可以包含三個主要組件。只需要第一個組件。
細胞類型的第一個也是最重要的規範是它的表達式。Garnett提供了幾種指定標記基因的選項,詳情如下。
1Format
2expressed: gene1, gene2
3not expressed: gene1, gene2
這是為你的細胞類型指定標記基因的默認方法。在使用這個規範時,Garnett為每個細胞計算一個標記分數,包括潛在的洩漏(leakage)、總體表達水平和read 深度。expressed:標記應該特定於所定義的細胞類型。
FormatExampleexpressed above: gene1 value, gene2 valueexpressed above: MYOD1 4.2, MYH3 700expressed below: gene1 value, gene2 valueexpressed below: PAX6 20, PAX3 4expressed between: gene1 value1 value2, gene2 value1 value2expressed between: PAX6 10 20, PAX3 4 100這是指定expression的另一種方法,如果您知道某個基因的確切表達範圍,這種方法會很有用。但是,通常我們不建議使用這些規範,因為它們不會考慮每個細胞中的read深度和總體表達。數據值與輸入數據的單位相同。
定義元數據除了表達式信息之外,您還可以使用元數據進一步細化細胞類型定義。這也是指定數據中所期望的任何子類型的地方。
FormatExamplesubtype of: celltypesubtype of: T cellscustom meta data: attribute1, attribute2tissue: spleen, thymussubtype of:允許您在定義文件中指定細胞類型是另一個細胞類型的子類型。
custom meta data:規範允許您為細胞類型提供任何進一步的元數據需求。CDS對象的pData表中的任何列都可以用作元數據規範。在上面的示例中,pData表中有一個名為「tissue」的列。
最後,我們強烈建議您記錄如何選擇標記定義。為了便於跟蹤,我們提供了一個額外的規範—references:—它將存儲每種類型的引用信息。添加一組url或DOIs,它們將包含在分類器中。有關訪問此信息的函數,請參見此處(https://cole-trapnell-lab.github.io/garnett/docs#viewing-references)。
添加注釋與R代碼類似,我們已經包含了一個注釋字符#,這樣您就可以在您的標記文件中添加注釋/注釋。任何在同一條線上的#之後的內容都會被忽略。
所以一個完整的例子是這樣的:
1>B cells
2expressed: CD19, MS4A1
3expressed above: CD79A 10
4references: https://www.abcam.com/primary-antibodies/b-cells-basic-immunophenotyping,
510.3109/07420528.2013.775654
6
7>T cells
8expressed: CD3D
9sample: blood # A meta data specification
10
11>Helper T cells
12expressed: CD4
13subtype of: T cells
14references: https://www.ncbi.nlm.nih.gov/pubmed/?term=1200072
目前,標記文件不能有回車(\r),如果您在某些Windows文本編輯器中生成標記文件,就會自動包括回車。相反,您必須使用換行字符(\n)。有許多方法可以在Windows上替換回車,例如使用notepad++,您可以使用replace、choose extended和replace all \r with \n。我打算儘快以更自動化的方式解決這個問題。
檢查標記因為定義標記文件通常是過程中最困難的部分,所以Garnett提供了一些函數來檢查標記是否能夠正常工作。相關的兩個函數是check_marker和plot_marker。check_marker生成關於標記的信息表,plot_marker繪製最相關的信息。
除了包含的小數據集之外,我們還在包中包含了兩個示例標記文件:pbmc_bad_markers.txt
在生成您的marker_check data.frame 之後,您可以使用我們內建的繪圖函數plot_marker來查看結果。
1library(org.Hs.eg.db)
2marker_file_path <- system.file("extdata", "pbmc_bad_markers.txt",
3 package = "garnett")
4marker_check <- check_markers(pbmc_cds, marker_file_path,
5 db=org.Hs.eg.db,
6 cds_gene_id_type = "SYMBOL",
7 marker_file_gene_id_type ="SYMBOL")
8
9plot_markers(marker_check)
db: db is a required argument for a Bioconductor AnnotationDb-class package used for converting gene IDs. For example, for humans use org.Hs.eg.db(http://bioconductor.org/packages/3.8/data/annotation/html/org.Hs.eg.db). See available packages at the Bioconductor website(http://bioconductor.org/packages/3.8/data/annotation/). Load your chosen db using library(db). If your species does not have an AnnotationDb-class package, see here(https://cole-trapnell-lab.github.io/garnett/docs/#my-species-doesn-t-hav).
cds_gene_id_type: This argument tells Garnett the format of the gene IDs in your CDS object. It should be one of the values in columns(db). The default is "ENSEMBL".
marker_file_gene_id_type: Similarly to above, this argument tells Garnett the format of the gene IDs in your marker file.
這個標記圖提供了一些關於所選標記是否正確的關鍵信息。首先,紅色標記「not in db」讓我們知道標記ACTN在org.Hs.eg.db注釋中沒有作為「SYMBOL」出現。在本例中,它是一個列印錯誤。接下來,x軸顯示每個標記的模糊度評分—當包含該標記時,測量有多少個cell接受了模糊標籤—在本例中,ACTB和PTPRC具有很高的模糊度,應該排除。
check_marker輸出的值和plot_marker繪製的值是分類器可以選擇的cell 數量的估計值。然而,它使用啟發式快速找到候選細胞,並不能完全匹配標記所選擇的細胞。請使用這些數字作為相對的度量,而不是訓練集的絕對表示。
關於歧義分數的進一步說明:歧義分數是當一個標記被包含在標記文件中時,一個標記被標記為「歧義」的cell 的分數。然而,一個高模糊度的分數並不一定意味著一個給定的標記是不具體的。這可能意味著一個不同的標記是罪魁禍首,但該標記也提名了許多其他未標記的細胞(高提名率)。在決定排除哪個標記之前,請仔細查看歧義度高的標記和最模糊的cell類型marker。
在製作標記圖之後,您可能想要修改標記文件。在我們的示例中,我們將刪除ACTN、ACTB和PTPRC以得到最終的「pbmc_test」。txt的標記文件。
默認情況下,Garnett 將基因id轉換成ENSEMBL用於分類器。這使得分類器是可移植的,這樣它們就可以對未來可能具有不同基因id的數據集進行分類。然而,對於某些生物體,ENSEMBL id要麼不可用,要麼不常用。在這些情況下,可以在train_cell_classifier和check_marker中使用參數classifier_gene_id_type來指定不同的ID類型。您選擇的值將與分類器一起存儲,因此在對未來的數據集進行分類時不需要再次指定它。
訓練分類器現在是訓練分類器的時候了。參數應該與check_marker的參數非常接近。下面我將從默認值更改的一個參數是num_unknown參數。這告訴Garnett 應該比較多少個外群細胞。默認值是500,但是在這個只有很少cell的數據集中,我們需要更少的cell。
1library(org.Hs.eg.db)
2set.seed(260)
3
4marker_file_path <- system.file("extdata", "pbmc_test.txt",
5 package = "garnett")
6pbmc_classifier <- train_cell_classifier(cds = pbmc_cds,
7 marker_file = marker_file_path,
8 db=org.Hs.eg.db,
9 cds_gene_id_type = "SYMBOL",
10 num_unknown = 50,
11 marker_file_gene_id_type = "SYMBOL")
12head(pData(pbmc_cds))
1> head(pData(pbmc_cds))
2DataFrame with 6 rows and 4 columns
3 tsne_1 tsne_2
4 <numeric> <numeric>
5AAGCACTGCACACA-1 3.8403149909359 12.0841914129204
6GGCTCACTGGTCTA-1 9.97096226657347 3.50539308651821
7AGCACTGATATCTC-1 3.45952940410281 4.93527280576176
8ACACGTGATATTCC-1 1.74394947394641 7.78267061846286
9ATATGCCTCTGCAA-1 5.78344829514223 8.55889827553495
10TGACGAACCTATTC-1 10.7928530485958 10.5852739146963
11 Size_Factor FACS_type
12 <numeric> <factor>
13AAGCACTGCACACA-1 0.559181445161514 B cells
14GGCTCACTGGTCTA-1 0.515934033527584 B cells
15AGCACTGATATCTC-1 0.698028398302026 B cells
16ACACGTGATATTCC-1 0.815631008885519 B cells
17ATATGCCTCTGCAA-1 1.11532798424345 B cells
18TGACGAACCTATTC-1 0.649469901028841 B cells
運行train_cell_classifier之後,類型為「garnett_classifier」的輸出對象包含對細胞進行分類所需的所有信息。
查看分類基因Garnett 分類是使用多項彈性-網絡回歸訓練(multinomial elastic-net regression)。這意味著選擇某些基因作為區分細胞類型的相關基因。所選擇的基因可能是有趣的,所以Garnett 包含了一個訪問所選擇基因的功能。注意:Garnett 沒有對輸入標記進行正則化,所以無論如何,它們都會被包含在分類器中。
我們用來查看相關基因的函數是get_feature_genes。參數是分類器,您想查看哪個節點(如果您的樹是分層的)—使用「root」作為頂部節點,使用父細胞類型名稱作為其他節點,使用db作為您的物種。如果設置convert_ids = TRUE,該函數將自動將基因id轉換為符號。
1feature_genes <- get_feature_genes(pbmc_classifier,
2 node = "root",
3 db = org.Hs.eg.db)
4head(feature_genes)
5 B cells T cells Unknown
6(Intercept) -4.44471924 2.590206989 1.85451225
7ENSG00000187608 -0.10903325 -0.199658082 0.30869133
8ENSG00000157873 0.06411921 -0.295797377 0.23167817
9ENSG00000157191 -0.07677221 -0.155893113 0.23266532
10ENSG00000173436 0.02649831 0.089393639 -0.11589195
11ENSG00000117318 0.07400983 -0.009415156 -0.06459467
12
我們在上面解釋了如何在標記文件中包含關於如何選擇標記的文檔。為了獲取這些信息—查看如何為已經訓練好的分類器選擇標記—使用函數get_classifier_references。除了分類器之外,還有一個額外的可選參數,稱為cell_type。如果傳遞細胞類型的名稱,則僅列印該單元類型的引用,否則將全部列印。
1get_classifier_references(pbmc_classifier )
2$`B cells`
3[1] "https://www.ncbi.nlm.nih.gov/pubmed/?term=23688120"
4[2] "https://www.ncbi.nlm.nih.gov/pubmed/?term=21149806"
5
6$`T cells`
7[1] "https://www.ncbi.nlm.nih.gov/pubmed/?term=1534551"
我們鼓勵你提交你的高質量的分類器給我們,這樣我們可以使他們對社區可用。為此,打開一個特刊並在Garnett github存儲庫中填寫表單。點擊這裡,點擊「New issue」按鈕開始!(https://github.com/cole-trapnell-lab/garnett/issues)
應用您的分類器單細胞轉錄組數據分析||Garnett細胞類型注釋工具