天子呼来不上船，
自称臣是菜鸟团。
在这里，和国际同行一起学习单细胞数据分析。
我今天并没有敲满100行代码，以至于我在写这篇文章的时候都有点不好意思了。要读/写长代码的想法脑海里轮回了很久了，哪来的时间呢？写吧。
我们为什么要学习长代码?
对大学毕业才开始学习一门语言的人来讲，学习基本概念并不是一件难事。Perl语言，听过吧，有那么多的操作符和参数，在不和C语言来比较的前提下，这并不是一个顺从人类本能的语言。
知道一门语言的基本概念是一回事，能写出一手好程序是另一回事。
Seurat Weekly 目前已经进行到第十四期了，之前我们读了它的很多帮助文档，这一次我们来试着读一读它的源代码。借此机会呢，也回答两个有趣的问题。
首先，我们把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
这时候就发挥程序员最能读文档的功能了，先把眼前看到的文档读一遍，至少要cat 一番，知道它是如何架构的。然后是找出除了配置文件之外最重要的一个文件。也许在之前我们非常想看vignettes，也就是教程，但是教程我们已经写的太多了，先把它往后排一点。这里我们先看 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));
}
要把这部分读完估计是要发一段时间的，下面我们看开一个比较轻松的模块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，也值当的。
在这里，我们提出两个问题，大家可以在留言区回答：
- 为什么Seurat的函数运行完返回的还是Seurat对象，它读入的和输出的都一样，好奇怪。
- 为什么Seurat的聚类结果中编号是从零开始的，而且，细胞数量依次递减
希望您从源码中给出你的看法。
