Shawn の Blog
文章目录 站点概览

Shawn Wang

Post-Doc Researcher

Bioinformatics

HENU

20 文章
17 分类
17 标签

「TBtools Plugin」批量生成气泡图

发布于 2021-02-02 | 分类于 TBtools 、 插件 、 富集分析 | 11分钟 | 2518字数 | 浏览量：

说出来你可能不信，我刚才用TBtools插件卡了个Bug！

不过CJ大佬看完我调皮操作之后，马上甩出了一个功能：支持输入路径（文件夹），因为之前只支持输入单个文件。

额，插件使用其实很简单，这次blog主要面向插件制作用户...

如何卡Bug成功....

最近在搞多组合的转录组分析，于是有了好多个富集分析的结果，虽然我以及在电脑上写好了富集分析-出图的代码流程（全程TBtools+R）写一个配置文件，一键批量做，但是之前的出图代码多少有点粗糙，我也不想再回去改R代码..毕竟我这水平，改自己的代码如同在写bug，所以就直接把出图的代码给注释掉了，后续大概有40个go和kegg富集分析结果，一个一个扔插件里跑要累死... 于是想着把bubble plot插件改一下，最后出图的时候写个循环。那么就存在一个问题。批量读入R的过程。

总结起来做TBtools的插件太简单了，如果你之前有现成的Rscript。完全可以直接写个config.txt的配置文件一打包就做成插件了...

我们先看下TBtools是怎么实现把你的参数可视化的。
首先看下config.txt的配置文件

App=Demo R-ggplot BarPlot
Script=script.r
# Optional
Icon=Icon.jpg
# Optional
Layout=2
# Optional
Demo=fpkm.xls
# Optional
Manual=Readme.txt
# Optional
Link=https://github.com/CJ-Chen/TBtools/releases
# All lines start with a "#" will be ignored.
# an input file/paste => Type=Note
File=Set a Tab-delimited Table
# text input => Type=Note=DefaultValue
Text=Plot Title:=R-ggplot2 BarPlot
# yes or no options => Type=Note
CheckBox=Log-tranformed
# multiple choice  => Type=Note=Choice1,Choice2,Choice3
Choice=Color Palette:=Set1,Set2,Set3
# Specify a Color
Color=Set a Color:=#e31a1c
# Demo Directory Select Panel
Directory=Set a Directory

这个是CJ释放的最新的插件demo中的config。最全参数的。其中

# an input file/paste => Type=Note
File=Set a Tab-delimited Table

到了TBtools界面上就是
File
CJ也对File这个选项进行了说明，就是输入的一个文件,而且存在一个Paste input，虽然不太理解Type=Note这种类型是什么，但是可以盲猜是字符，比如在我GO bubble Plot插件中，在把Term Number这个变量赋值R的时候要用as.numeric转换成数字。实际上在使用R脚本的时候读入文件，Rscript /path/file 这里变量所使用的也是路径，说白了就是一串字符。

那么可以先做两个假设：

  1. CJ大佬使用了基于TBtools或者Java的骚操作把你读入的**“文件”**最后一顿操作最后生成一个专有的路径读近R... （可能产生一些中间文件，临时文件等...）
  2. 大道至简，直接把你输入的路径给了R...（感觉是这样的....）

我感觉是第二个，这个就意味着我可以卡个bug。我把路径扔到文件选项框里，TBtools会提示你放入的不是一个文件，如果软件逻辑里面这里有个报错打断的话，后面可能就gg了，但是没有，这里估计会有个提示，但是后面的代码还是运行了。那么就实现了后面还继续跑，我把路径下包含特征字符的文件批量读近TBtools，最后批量生产气泡图。

Bug成功截图
Bug
虽然提示文件不可用，但是跑出来了，哈哈。

然后群里卖了个萌，大佬一个滑铲插件的两个新功能诞生了：

Update | TBtools R Plugin 制备套件更新

  • Color，不需要在手动输入16进制颜色代码，直接调用TBtools的调色板，点击选择就可以
  • Directory，支持了路径输入。

插件的使用

先看下新的界面：
Batch Enrichment

  • 界面和GO bubble Plot类似，file input改成了directory input。

这里把你做好的富集分析文件放到一个文件夹下，为了不必要的麻烦，这些文件中最好不要有特殊字符（比如引号，括号，空格，/ \ |等....）而且这些文件名要有共同的特征 比如TBtools直接输入的GO富集分析最终结果文件最后都有。 *.final.xls如果有一定coding基础或者知道通配符的话可以知道，后续批量读入就是靠这些特征读取的。

  • pattern只的就是你要批量富集的这些结果文件名共有的特征。
  • 剩下的参数参考GO Bubble Plot那篇文章：

『TBtools-plugin』Bubble plot插件

  • 这里吧min和max改成了TBtools新设定的Color类型。不在是之前的Text类型。

如果你对TBtools插件制作感兴趣，继续看下面的内容

配置文件和批量读入

看下我的配置文件

App=Batch Bubble plot ## 插件显示的名字
Script=BatchBubble.R ## 执行的脚本文件名
# Optional
Icon=Icon.png  ## 插件上显示图片文件名
# Optional
Layout=4 ## 布局
# Optional
Manual=BatchBubble.html ## 操作手册
# Optional
Link=https://gitee.com/shawnmagic/swtbplugin ## 你想放入的链接
# All lines start with a "#" will be ignored.
# input dir
## 最后一个等号后面的值相当于默认值（default）会直接显示在插件上。
Directory=Set a Directory ## Directory就是设定插件上输入路径的方框 对应脚本中的第一个变量
## Pattern
Text=pattern:=*.final.xls ## 这里是输入参数Pattern这个参数，对应第二个变量
## go terms num 
Text=Term Number:=30 ## 展示的GOterm个数 对应第三个变量
# multiple choice  => Type=Note=Choice1,Choice2,Choice3
Choice=Input Data Form:=TBtools_GO,TBtools_KEGG,customized ## 富集文件类型选项 第四个变量
Choice=Graph Type:=Bubble,bar ##图片类型选项 第5个变量
# color
Color=min:=#e41a1c ## 最小值颜色 第6个选项
Color=max:=#3300ff ## 最大值颜色 第7个选项

就这么多，这样就把插件的布局做好了。再看下对应脚本内的设置

参数设置和调试信息

##########################################################
#     prj:  Enrichment result Enrichment Visualization
#     date: 06 Jan 2021
#     Author: Shawn Wang
##########################################################
options(stringsAsFactors = F)
options("repos" = c(CRAN="https://mirrors.tuna.tsinghua.edu.cn/CRAN/"))
argv <- commandArgs(TRUE)
expfile <- argv[1] # 'file '
pattern <- argv[2]
num <- argv[3] #  "how many go terms do you want to show"
num = as.numeric(num)
DataF <- argv[4] # "data formate"
Gtype <- argv[5] # 'barplot or Bubble'
colormin <- argv[6] # 'pvalue color'
colormax <- argv[7] # 'pvalue color'
# print(Gtype)
if (!require('ggplot2')) install.packages('ggplot2')
if (!require('dplyr')) install.packages('dplyr')
if (!require('stringr')) install.packages('stringr')
if (!require('magrittr')) install.packages('magrittr')
library(ggplot2)
library(dplyr)
library(magrittr)
library(stringr)
## test set
# setwd("~/03.project/01.Heterosis/03.process/02.Enrichment/01.GOEnrich/03.graph/")
# expfile = "~/03.project/01.Heterosis/03.process/02.Enrichment/01.GOEnrich/03.graph/"
# pattern = "*.DEList.xls.GO.Enrichment.final.xls"
# num = 30
# DataF = "TBtools_GO"
# Gtype = "Bubble"
# colormin = "red"
# colormax = "blue"

  • 开始的两个option是我的习惯... 根据自己习惯来

  • 变量设置，可以对应回config，config中的参数顺序和这里面argv中变量的顺序要保持一致。最好按顺序来，防止把自己搞懵逼了。

argv <- commandArgs(TRUE)
expfile <- argv[1] # 'file '
pattern <- argv[2]
num <- argv[3] #  "how many go terms do you want to show"
num = as.numeric(num)
DataF <- argv[4] # "data formate"
Gtype <- argv[5] # 'barplot or Bubble'
colormin <- argv[6] # 'pvalue color'
colormax <- argv[7] # 'pvalue color'

下面是检查有没有你需要的包，没有的话安装

if (!require('ggplot2')) install.packages('ggplot2')
if (!require('dplyr')) install.packages('dplyr')
if (!require('stringr')) install.packages('stringr')
if (!require('magrittr')) install.packages('magrittr')
library(ggplot2)
library(dplyr)
library(magrittr)
library(stringr)
  • 调试，我有个习惯，写完脚本会先拿示例数据在Rstudio中调试一下能不能跑明白，所以我保留了调试信息，最后记得（cmd+shift+c或者ctrl+shift+c把这段代码注释掉...）;然后会用Rscript 在终端下跑一遍...最后再打包，不然打包好，再拆了改代码特别蛋疼....

最后放一个批量读入文件的function
当然大家有自己熟悉的方式，这里只是提供一个我习惯的解法...

## readfile
BatchReadTable = function(path, pattern,sep = "\t", header = TRUE, quote = "", stringsAsFactors = FALSE){
  fileNames.raw <- dir(path, pattern = pattern) 
  filePath.raw <- sapply(fileNames.raw, function(x){ 
    paste(path,x,sep='/')})
  data.raw <- lapply(filePath.raw, function(x){
    read.table(x, sep = sep,header = header,quote = quote,stringsAsFactors = FALSE)}) 
  x = list(Name = fileNames.raw,
           file = data.raw)
  return(x)
}
## 批量读入文件
raw = BatchReadTable(path = expfile,pattern = pattern, quote = NULL)
## 输出
rawdata = raw$file ## 输入富集分析文件
rawname = gsub(pattern,"",raw$Name) ## 去掉共有的Pattern就是每个文件剩下独有的特征字符串.这些rawnames会作为最后输出文件的特征

  • function最后返回一个list, list包含两个内容

    • Name是文件名，后续会用gsub把你输入的pattern去掉，留下每个文件独有的特征字符串。这个字符串最后会被用作命名输出文件，或者图片的title等。
    • file也是一个list，里面包含了读入的文件。

  • 下面是输出的选项，分了3部分，第一部分根据你选择画图，第二部分根据最长的GO term或者KEGG Pathway确定输出图片的宽度，根据你挑选的输出的GO term数量确定高度生成图片的size。最后一部分输出图片。

  • 这里对list的取索引的操作就是[[i]]

for (i in 1:length(rawdata)) {
  x = rawdata[[i]]
  y = rawname[i]
  colnames(x)
  if (DataF == "TBtools_GO") {
    out = GOBubblePlot(dataraw = x,
                       num = num,
                       name = y,
                       colormin = colormin,
                       colormax = colormax,
                       Gtype = Gtype)
  } else if (DataF == "TBtools_KEGG") {
    out = KEGGBubblePlot(dataraw = x,
                         num = num,
                         name = y,
                         colormin = colormin,
                         colormax = colormax,
                         Gtype = Gtype)
  } else if (DataF == "customized") {
    out = customBubblePlot(dataraw = x,
                           num = num,
                           name = y,
                           colormin = colormin,
                           colormax = colormax,
                           Gtype = Gtype)
  }
  
  figsize = function(y,num){
    z = data.frame(ID = y,
                   wc = 0)
    
    for (i in 1:nrow(z)) {
      z[i,2] = nchar(as.character(z$ID[i]))
    }
    maxwc = max(z$wc)
    if (maxwc <= 50) {
      figwidth = 10
    } else if (maxwc >50 & maxwc <100) {
      figwidth = 12
    } else {
      figwidth = 15+(maxwc-50)/25
    }
    if (nrow(z) <= 30) {
      fighight = 10
    } else if (nrow(z) >30 & nrow(z) <60) {
      fighight = 12
    } else {
      fighight = nrow(z)/4
    }
    size = list(figwidth = figwidth,
                fighight = fighight)
    return(size)
  }
  size = figsize(y = out$y,
                 num = num)
  
  ggsave(filename = paste(rawname[i],DataF,Gtype,"plot.pdf",sep = "."),
         plot = out$p,
         width=size$figwidth,
         height=size$fighight,
         dpi = 300)
  
}

感觉工作就这么多啦，也挺简单的。菜鸟先抛转引玉，
坐等各位大佬贡献更牛批的TBtools插件！

# TBtools # 插件 # 富集分析
「TBtools Plugin」使用openBLAS或Apple's BLAS是你的R矩阵运算速度起飞 上一篇
「TBtools-Plugin」Bubble Plot升级版-TBtools插件 下一篇
召唤看板娘