R语言笔记6：在R中写一些简单的函数、functions基础和作用域

R语言基础系列：

Your first R function

命令一个函数时，一般不写在交互式命令行里，而是写在一个空白的文本文件中，即把函数放在一个R包中，这里面包含着文档（documentation），是一个更加结构化的环境。

我们使用的软件是RStudio，左上角新建一个新的R脚本来写代码。

Example 1

举个例子，简单了解一下如何使用函数的语法、如何指定参数以及如何返回结果：

命令一个简单的函数，求x, y的和。

1. ## 给函数赋值为add2，第一行小括号里写进变量，第二行大括号里写入运算

2. add2 <- function(x, y) {

3.  x + y

4. }

5. ## 因为R函数会返回最后一个表达式的值，所以不用写返回

在控制台（console）运行脚本，赋值后即可得到结果：

1. > add2 <- function(x, y) {

2. +   x + y

3. + }

4. > add2(7, 5)

5. [1] 12

Example 2

下一个例子稍微复杂一点：

我们要输入一个数字向量，然后返回这个向量的子集（返回其中大于10的数字）

1. above10 <- function(x){   ##  命名变量

2.    use <- x > 10         ##  逻辑语句，来判断变量x是否大于10

3.    x[use]                ##  取子集

4. }

运行：

1. > above10 <- function(x){

2. +   use <- x > 10

3. +   x[use]

4. + }

5. > x <- 1:16

6. > above10(x)  

7. [1] 11 12 13 14 15 16

8. > above10(1:9)

9. integer(0)

如果我们不设置10，而是改成任意数字n，以上命令可改写为：

1. above <- function(x, n){

2.  use <- x > n

3.  x[use]

4. }

运行：

1. > above <- function(x, n){

2. +   use <- x > n

3. +   x[use]

4. + }

5. > x <- 1:16

6. > above(x, 12)

7. [1] 13 14 15 16

设置“缺省值”（可以理解为默认值），即如果在函数运行过程中不指定n的值时，系统自动筛选的标准：

1. above <- function(x, n = 10){   ## 设置缺省值为10

2.  use <- x > n

3.  x[use]

4. }

这时当你运行函数时：

1. > above <- function(x, n = 10){

2. +   use <- x > n

3. +   x[use]

4. + }

5. > above(x)     ## 自动筛选数字向量中大于10的数字

6. [1] 11 12 13 14 15 16

Example 3

下面这个例子再复杂一点，我们要给函数一个参数，然后使用循环遍历这个函数的每一列：

比如，取一个矩阵，然后计算每列的平均值：

1. columnmean <- function(x){   ## 给函数命名，设置参数x，用于储存矩阵

2.  nc <- ncol(x)              ## 计算矩阵中有多少列

3.  means <- numeric(nc)       ## 设置数值向量储存列数，长度等于列数，它是一个空向量，每个元素的初始值为0，数值在循环中填满。

4.  for (i in 1:nc){           ## 设置循环，循环参数在整数向量1到列数之间

5.    means[i] <- mean(x[,i])  ## 把每一列的平均值赋予means[i]，x[,i]是矩阵取子集，即求每列的平均值

6.  }

7.  means                 ## 返回means，平均值向量

8. }

运行这个程序，计算 airquality数据集每列的平均值：

ps. airquality数据集有6列，前六行长这样：

1. > head(airquality)

2.  Ozone Solar.R Wind Temp Month Day

3. 1    41     190  7.4   67     5   1

4. 2    36     118  8.0   72     5   2

5. 3    12     149 12.6   74     5   3

6. 4    18     313 11.5   62     5   4

7. 5    NA      NA 14.3   56     5   5

8. 6    28      NA 14.9   66     5   6

运行脚本可以看到函数 columnmean(airquality)返回了6个平均值：

1. > columnmean <- function(x){

2. +   nc <- ncol(x)

3. +   means <- numeric(nc)

4. +   for (i in 1:nc){

5. +     means[i] <- mean(x[,i])

6. +   }

7. +   means

8. + }

9. > columnmean(airquality)

10. [1]        NA        NA  9.957516 77.882353  6.993464 15.803922

可以看到，如果某列有缺失值NA的话，计算得出的数值就直接是NA。

所以我们可以添加一个逻辑参数，设置移除缺失值：

1. columnmean <- function(x, removeNA = TRUE){   ## 添加参数，并设置缺省值为TRUE

2.  nc <- ncol(x)

3.  means <- numeric(nc)

4.  for (i in 1:nc){

5.    means[i] <- mean(x[,i], na.rm = removeNA)   ## 在mean()函数中添加参数

6.  }

7.  means

8. }

再次运行程序，可以看到计算结果是默认移除NA后求得的平均值：

1. > columnmean(airquality)

2. [1]  42.129310 185.931507   9.957516  77.882353   6.993464  15.803922

Functions in R

主要分三个部分来讲解函数：

• 编写函数所需的基础知识

• 相关语法作用域

• R语言作用域的规则

编写函数所需的基础知识

R语言通过 function()指令来命名和创建函数。首先要给函数赋值，也就是命名，然后在小括号中写入参数，最后再大括号中写入函数要执行的语句，其基本语法是：

1. f <- function(<arguments>){

2.    ## Do something interesting

3. }

同时在R中，你可以将函数作为参数传递给其他函数，即嵌套。

函数的返回值是函数执行部分中的最后一行表达式。

编写函数的过程中我们可以设置和命名参数，这些参数可以代表数值、矩阵、数据框或逻辑值等等。同时也可以设置一些具有缺省值（默认值）的参数。

• 形式参数（formal arguments）

形式参数是包含在函数定义里的参数。

formals()会将一个函数作为输入（input），并返回函数所有的形式参数组成的列表。

在R中，不是所有命令都用到所用的形式参数。加入一个函数中设置了10个参数，但我们往往并不需要指定每个参数的值是啥，所以函数可以缺失某些参数。当没有明确赋值是，它的取值就是缺省值（默认值，default value）

• 匹配参数（argument matching）

可以根据位置或名称来匹配函数参数，这是编写和调用函数的关键。

以计算数据标准差的函数 sd()为例。

1. > data <- rnorm(100)    ## 取100个符合正态分布的随机数

2. > sd(x = data)          ## 给参数赋值 求标准差

3. [1] 1.035329

4. > sd(data)              ## 给参数默认赋值

5. [1] 1.035329

6. > sd(data, na.rm = FALSE)

7. [1] 1.035329

8. > sd(na.rm = FALSE, data)  ## 调换参数位置后结果不变

9. [1] 1.035329

以上所有表达式都是等价的，但是最好不要调换参数位置。

如果函数中参数较多，那么最好使用位置匹配。

比如 lm()函数（把数据拟合到线性模型），它的参数列表这么长：

1. > args(lm)

2. function (formula, data, subset, weights, na.action, method = "qr",

3.    model = TRUE, x = FALSE, y = FALSE, qr = TRUE, singular.ok = TRUE,

4.    contrasts = NULL, offset, ...)

5. NULL

前五个参数都没有缺省值，依次是，公式、数据、子集、权重等。这里使用者必须要指定他们的值。

1. lm(y ~ x, mydata, 1:100, model = FALSE)

大多数情况下，我们不知道参数的具体位置，所以在命令行中，命名参数来匹配最安全。

The order of operations when given an argument is：

1. Check for exact match for a named argument

2. Check for a partial match

3. Check for a positional match

• 惰性求值（Lazy Evaluation）

惰性求值是R语言的一个关键特性，也是许多编程语言常用的模型。仅在使用函数参数时对其求值。

第一个例子：

1. > f <- function(a, b) {

2. +         a^2

3. + }

4. > f(2)

5. [1] 4

这里定义函数f，有两个参数，但返回值仅仅是a的平方。所以当运行f(2)时，和b无关，所以系统自动跳过，不会报错。

第二个例子：

1. > f <- function(a, b) {

2. +         print(a)

3. +         print(b)

4. + }

5. > f(45)

6. [1] 45

7. Error in print(b): argument "b" is missing, with no default

这里同样定义f有两个参数，但返回值是a和b，所以当输入f(45)时，因为第二个位置上缺少b的赋值，所以会报错。这里就是用了惰性求值，即，仅在使用这个参数的时候进行求值，在这之前的程序都是有效的并可以执行，直至运行到出错的部分。

• 特殊参数 ...

...参数是一种特殊的参数，表明一些可以传递给另一个函数的参数。常用于当你需要扩展另一个函数，而你又不想复制原函数的整个参数列表时。

如下例，你希望修改 plot()函数中的个别参数，而其他参数保持不变，将其应用于一个新定义的函数中 myplot()：

1. myplot <- function(x, y, type = "l", ...) {

2.        plot(x, y, type = type, ...)         ## Pass '...' to 'plot' function

3. }

在泛型函数（generic function）中， ...还有另一种用法，它的作用是根据数据类型使用合适的方法

泛型函数是一个函数族，其中的每个函数都有相似的功能，但是适用于某个特定的类。

1. > mean

2. function (x, ...)

3. UseMethod("mean")

4. <bytecode: 0x5d5e3e8>

5. <environment: namespace:base>

还有一种情况下， ...参数必须使用：

那就是，当传递到函数的参数数量不能事先确定的时候。

比如 paste()函数，他的作用是将一连串字符串连接起来，然后新建一个字符串或向量，所以无法预知参数个数：

1. > args(paste)

2. function (..., sep = " ", collapse = NULL)

3. NULL

还有 cat()函数，它的功能是和 paste相似，也是连接字符串。

1. > args(cat)

2. function (..., file = "", sep = " ", fill = FALSE, labels = NULL,

3.    append = FALSE)

4. NULL

使用 ...函数的一个注意事项：

就是任何出现在 ...之后的参数列表必须明确的给出名称。而且不能够部分匹配或位置匹配

举例：

1. > paste("a","b",sep = ":")

2. [1] "a:b"

不能位置匹配或部分匹配：

1. > paste("a","b",":")

2. [1] "a b :"

3. > paste("a","b",se = ":")

4. [1] "a b :"

Scoping Rules of R

作用域（scope，或译作有效范围）是名字（name）与实体（entity）的绑定（binding）保持有效的那部分计算机程序。

什么是作用域规则？

作用域规则（Scoping Rules）决定了一个函数的值如何与自变量绑定起来

在一个函数中，有两种类型的变量：

一种是函数的参数，

另一种存在于函数中的其他变量或符号，并非是函数的参数。问题在于你如何给这些符号赋值。

R用的是词法作用域（Lexical Scoping），也成静态作用域。

词法作用域又叫做静态作用域，采用词法作用域的变量叫词法变量。

词法作用域里，取变量的值时，会检查函数定义时的文本环境，捕捉函数定义时对该变量的绑定。

词法变量有一个在编译时静态确定的作用域。词法变量的作用域可以是一个函数或一段代码，该变量在这段代码区域内可见（visibility）；在这段区域以外该变量不可见（或无法访问）。

相反，采用动态作用域的变量叫做动态变量。

只要程序正在执行定义了动态变量的代码段，那么在这段时间内，该变量一直存在；代码段执行结束，该变量便消失。

词法作用域的优点是能够简化运算，在统计分析时非常有效

通过下面这个函数，举个栗子：

f <- function(x, y) {  x^2 + y / z }

这个函数是取x的平方然后加上y除以z的值，其中有两个明确的形式参数x和y，问题是z从哪儿来的？

因为没有在函数中定义z，所以z是一个自由变量。

语法作用域解决的问题就是怎样给一个类似z的自由变量赋值。

---

词法作用域的规则

词法作用域的规则，简而言之一句话：

在定义函数的环境中搜索自由变量的值。

那么问题来了……

什么是环境？

环境是符号-值对（symbol-value，如x = 3.14）的集合。每一个符号都有一个与之绑定的值。

每个环境都有一个上层环境（parent environment）。对于上层环境而言，他可能有很多子环境。唯一没有上层环境的环境叫做空环境。

你可以把你的全局环境（工作空间）看做一系列“符号-值对”，其中每个对象都有一个与之关联的对象。

因此，每一个包都有一个命名空间，就是一个环境，其中有很多符号、以及与符号关联的值。

如果你把一个函数和环境联系起来，就创建了一个闭包（function losure），这些闭包是R中各种各样神器操作的关键所在。

---

所以，如果要在函数里遇到自由变量，怎么办？

先你需要找的是：这个函数是在那个环境中被定义的。看看是否在全局环境中被定义，如果没有，就去它的父环境里面找，以此类推，往上找直到顶层环境。（在全局环境外定义函数也是有可能的）

如果所有环境中都找不到想要的符号的话，就会报错。

---

作用域规则的重要性

为什么作用域规则很重要？

通常在全局环境重定义一个函数，在工作区就能够找到自由变量的值。

但是重点是，在R中，你能够在函数里面再定义其他函数。

一般情况下，函数的返回值是数值、数据框、列表、等等，但也有可能是一个函数。

在这种情况下，全局环境就产生了变化，作用域原则的影响就表现出来了。

举例，定义一个“构造性”函数，即这个函数在构造另一个函数：

make.power <- function(n) {  pow <- function(x){    x^n  }  pow }

创建一个构造函数mmake.power()，赋值为n；其内部用来构造另一个函数pow()，赋值为x。这个函数的功能是，pow()对它的参数x求n次方，然后make.power()返回结果。

所以在函数pow()的内部，x是参数，n就是一个自由变量。

所以如果运行函数make.power，赋值给cube，那么cube就会返回一个函数：

> cube <- make.power(3) > cube function(x){    x^n  } <environment: 0xc8d30e8>

这时，cube就成了一个函数cube()，相当于pow()（实际上是没有pow的，他只是一个内部的代号），所以调用cube()：

> cube(2) [1] 8

（2的立方是8）

---

Exploring a Function Closure

怎么才能查看一个函数所在的环境中都有啥？

调用ls函数

如上例：

> ls(environment(cute)) [1] "n"   "pow"

查看对象的赋值，使用get()：

> get("n", environment(cute)) [1] 3

这就是cute()怎么知道n=3的过程。

---

参考资料：

1. 视频课程 R Programming by Johns Hopkins University：https://www.coursera.org/learn/r-programming/home/welcome

2. 讲义 Programming for Data Science ：https://bookdown.org/rdpeng/rprogdatascience/R

-------------------我是求关注的分界线--------------

欢迎大家跟我一起上车~~~~请关注

猜你喜欢

系列教程：微生物组入门 Biostar 微生物组  宏基因组

专业技能：生信宝典 学术图表 高分文章 不可或缺的人

一文读懂：宏基因组 寄生虫益处 进化树

必备技能：提问 搜索  Endnote

文献阅读 热心肠 SemanticScholar Geenmedical

扩增子分析：图表解读 分析流程 统计绘图

在线工具：16S预测培养基 生信绘图

科研经验：云笔记  云协作 公众号

编程模板 Shell  R Perl

生物科普  生命大跃进  细胞暗战 人体奥秘  

写在后面

为鼓励读者交流、快速解决科研困难，我们建立了“宏基因组”专业讨论群，目前己有国内外150+ PI，1300+ 一线科研人员加入。参与讨论，获得专业解答，欢迎分享此文至朋友圈，并扫码加主编好友带你入群，务必备注“姓名-单位-研究方向-职称/年级”。技术问题寻求帮助，首先阅读《如何优雅的提问》学习解决问题思路，仍末解决群内讨论，问题不私聊，帮助同行。

学习16S扩增子、宏基因组科研思路和分析实战，关注“宏基因组”

点击阅读原文，跳转最新文章目录阅读