Seurat Weekly NO.14 || 讀源碼解決實際問題

天子呼來不上船苫拍,
自稱臣是菜鳥團瓜富。

在這里,和國際同行一起學習單細胞數(shù)據(jù)分析纽什。

我今天并沒有敲滿100行代碼措嵌,以至于我在寫這篇文章的時候都有點不好意思了。要讀/寫長代碼的想法腦海里輪回了很久了芦缰,哪來的時間呢铅匹?寫吧。

我們?yōu)槭裁匆獙W習長代碼?

對大學畢業(yè)才開始學習一門語言的人來講饺藤,學習基本概念并不是一件難事包斑。Perl語言,聽過吧涕俗,有那么多的操作符和參數(shù)罗丰,在不和C語言來比較的前提下,這并不是一個順從人類本能的語言再姑。

知道一門語言的基本概念是一回事萌抵,能寫出一手好程序是另一回事。

Seurat Weekly 目前已經(jīng)進行到第十四期了,之前我們讀了它的很多幫助文檔绍填,這一次我們來試著讀一讀它的源代碼霎桅。借此機會呢,也回答兩個有趣的問題讨永。

首先滔驶,我們把Seurat的源代碼clone 到 本地便于我們查找和閱讀。

git clone  https://github.com/satijalab/seurat.git 

然后我們就要在結構上看看Seurat的框架

tree -L  1 
.
|-- CODE_OF_CONDUCT.md
|-- DESCRIPTION
|-- LICENSE
|-- NAMESPACE
|-- NEWS.md
|-- R
|-- README.md
|-- _pkgdown.yaml
|-- appveyor.yml
|-- azure-pipelines.yml
|-- cran-comments.md
|-- data
|-- index.md
|-- inst
|-- man
|-- seurat.Rproj
|-- src
|-- tests
|-- travis_setup.sh
`-- vignettes

這時候就發(fā)揮程序員最能讀文檔的功能了卿闹,先把眼前看到的文檔讀一遍揭糕,至少要cat 一番,知道它是如何架構的锻霎。然后是找出除了配置文件之外最重要的一個文件著角。也許在之前我們非常想看vignettes,也就是教程旋恼,但是教程我們已經(jīng)寫的太多了吏口,先把它往后排一點。這里我們先看 R 這個文件夾:

.
|-- RcppExports.R
|-- clustering.R
|-- convenience.R
|-- data.R
|-- differential_expression.R
|-- dimensional_reduction.R
|-- generics.R
|-- integration.R
|-- mixscape.R
|-- objects.R
|-- preprocessing.R
|-- reexports.R
|-- tree.R
|-- utilities.R
|-- visualization.R
|-- zfRenderSeurat.old
`-- zzz.R

我們也看到這里都是點R的文件冰更,也就是R腳本锨侯,這時候我們就需要挨個來看了。當然了冬殃,如果你是比較喜歡畫圖囚痴,可以先學visualization.R,這里有實打實的可視化腳本,腳本太長审葬,我們就不再展示了深滚。不管從哪里開始最終都是要全看的,不是說要背下來涣觉,而是學習人家寫代碼的風格和一些小的技巧痴荐。然而,這里可能回憶道一個閱讀障礙官册,那就是RcppExports.R 這個腳本生兆,和一般的R代碼不同,里面幾乎都是這個格式的代碼:

RunModularityClusteringCpp <- function(SNN, modularityFunction, resolution, algorithm, nRandomStarts, nIterations, randomSeed, printOutput, edgefilename) {
    .Call('_Seurat_RunModularityClusteringCpp', PACKAGE = 'Seurat', SNN, modularityFunction, resolution, algorithm, nRandomStarts, nIterations, randomSeed, printOutput, edgefilename)
}

RunUMISampling <- function(data, sample_val, upsample = FALSE, display_progress = TRUE) { 
    .Call('_Seurat_RunUMISampling', PACKAGE = 'Seurat', data, sample_val, upsample, display_progress)
}

RunUMISamplingPerCell <- function(data, sample_val, upsample = FALSE, display_progress = TRUE) { 
    .Call('_Seurat_RunUMISamplingPerCell', PACKAGE = 'Seurat', data, sample_val, upsample, display_progress)
}

于是我們就要找到Rcpp到底在哪放著膝宁。在src的目錄下放著:

|-- Makevars
|-- ModularityOptimizer.cpp
|-- ModularityOptimizer.h
|-- RModularityOptimizer.cpp
|-- RcppExports.cpp
|-- data_manipulation.cpp
|-- data_manipulation.h
|-- fast_NN_dist.cpp
|-- integration.cpp
|-- integration.h
|-- snn.cpp
|-- snn.h
`-- valid_pointer.c

想要看懂這些代碼除了四級詞匯還需要一些C語言的基礎知識鸦难。其實真看的話也并沒有那么難,一行一行讀就是了员淫,《紅樓夢》都看了合蔽。

#include "ModularityOptimizer.h"

#include <algorithm>
#include <exception>
#include <functional>
#include <numeric>
#include <stdexcept>

using namespace ModularityOptimizer;
using namespace std::chrono;

JavaRandom::JavaRandom(uint64_t seed) { 
  setSeed(seed);
}

void JavaRandom::setSeed(uint64_t seed) { 

  this->seed = (seed ^ uint64_t(0x5DEECE66D)) & ((uint64_t(1) << 48) - 1);
}

int JavaRandom::next(int bits) { 
  // Only 31 bits ever used.
  seed = (seed * uint64_t(0x5DEECE66D) + uint64_t(0xB)) & ((uint64_t(1) << 48) - 1);
  return static_cast<int>(seed >> (48 - bits)); 
}

要把這部分讀完估計是要發(fā)一段時間的,下面我們看開一個比較輕松的模塊vignettes是大家比較熟悉的教程介返,一個教程一個md拴事。

.
|-- archive.Rmd
|-- archive.yaml
|-- assets
|-- atacseq_integration_vignette.Rmd
|-- cell_cycle_vignette.Rmd
|-- conversion_vignette.Rmd
|-- de_vignette.Rmd
|-- dim_reduction_vignette.Rmd
|-- essential_commands.Rmd
|-- extensions.Rmd
|-- future_vignette.Rmd
|-- get_started.Rmd
|-- hashing_vignette.Rmd
|-- install.Rmd
|-- integration_introduction.Rmd
|-- integration_large_datasets.Rmd
|-- integration_mapping.Rmd
|-- integration_rpca.Rmd
|-- interaction_vignette.Rmd
|-- merge_vignette.Rmd
|-- mixscape_vignette.Rmd
|-- multimodal_reference_mapping.Rmd
|-- multimodal_vignette.Rmd
|-- pbmc3k_tutorial.Rmd
|-- sctransform_vignette.Rmd
|-- spatial_vignette.Rmd
|-- v4_changes.Rmd
|-- vignettes.yaml
|-- visualization_vignette.Rmd
`-- weighted_nearest_neighbor_analysis.Rmd

看完本文你也許會納悶:為什么總有人在找教程沃斤,源代碼里面不是滿滿的教程嗎?而且是Rmd的拿出來那是可以直接跑的啊刃宵,到處找人要什么pipeline衡瓶,也值當?shù)摹?/p>

在這里,我們提出兩個問題牲证,大家可以在留言區(qū)回答:

  • 為什么Seurat的函數(shù)運行完返回的還是Seurat對象哮针,它讀入的和輸出的都一樣,好奇怪从隆。
  • 為什么Seurat的聚類結果中編號是從零開始的,而且缭裆,細胞數(shù)量依次遞減

希望您從源碼中給出你的看法键闺。

?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市澈驼,隨后出現(xiàn)的幾起案子辛燥,更是在濱河造成了極大的恐慌,老刑警劉巖缝其,帶你破解...
    沈念sama閱讀 218,682評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件挎塌,死亡現(xiàn)場離奇詭異,居然都是意外死亡内边,警方通過查閱死者的電腦和手機榴都,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,277評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來漠其,“玉大人嘴高,你說我怎么就攤上這事『褪海” “怎么了拴驮?”我有些...
    開封第一講書人閱讀 165,083評論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長柴信。 經(jīng)常有香客問我套啤,道長,這世上最難降的妖魔是什么随常? 我笑而不...
    開封第一講書人閱讀 58,763評論 1 295
  • 正文 為了忘掉前任潜沦,我火速辦了婚禮,結果婚禮上绪氛,老公的妹妹穿的比我還像新娘止潮。我一直安慰自己,他們只是感情好钞楼,可當我...
    茶點故事閱讀 67,785評論 6 392
  • 文/花漫 我一把揭開白布喇闸。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪燃乍。 梳的紋絲不亂的頭發(fā)上唆樊,一...
    開封第一講書人閱讀 51,624評論 1 305
  • 那天,我揣著相機與錄音刻蟹,去河邊找鬼逗旁。 笑死,一個胖子當著我的面吹牛舆瘪,可吹牛的內(nèi)容都是我干的片效。 我是一名探鬼主播,決...
    沈念sama閱讀 40,358評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼英古,長吁一口氣:“原來是場噩夢啊……” “哼淀衣!你這毒婦竟也來了?” 一聲冷哼從身側響起召调,我...
    開封第一講書人閱讀 39,261評論 0 276
  • 序言:老撾萬榮一對情侶失蹤膨桥,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后唠叛,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體只嚣,經(jīng)...
    沈念sama閱讀 45,722評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年艺沼,在試婚紗的時候發(fā)現(xiàn)自己被綠了册舞。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,030評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡障般,死狀恐怖环础,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情剩拢,我是刑警寧澤线得,帶...
    沈念sama閱讀 35,737評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站徐伐,受9級特大地震影響贯钩,放射性物質發(fā)生泄漏。R本人自食惡果不足惜办素,卻給世界環(huán)境...
    茶點故事閱讀 41,360評論 3 330
  • 文/蒙蒙 一铁追、第九天 我趴在偏房一處隱蔽的房頂上張望宙彪。 院中可真熱鬧臼闻,春花似錦愕鼓、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,941評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽祈远。三九已至,卻和暖如春商源,著一層夾襖步出監(jiān)牢的瞬間车份,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,057評論 1 270
  • 我被黑心中介騙來泰國打工牡彻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留扫沼,地道東北人。 一個月前我還...
    沈念sama閱讀 48,237評論 3 371
  • 正文 我出身青樓庄吼,卻偏偏與公主長得像缎除,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子总寻,可洞房花燭夜當晚...
    茶點故事閱讀 44,976評論 2 355

推薦閱讀更多精彩內(nèi)容