👨‍💻For BioMate开发者

本文档介绍如何封装一个BioMate的插件

输入文件类型介绍

BioMate中主要分6种类型文件，此处感谢Hiplot开源项目，以Hiplot的工具类型文件为参照，也方便后续集成Hiplot的开源工具

  1. metadata文件：metadata文件主要是用于介绍此工具的基本信息，包括工具名称、

  2. UI文件（ui.json）:对于Notebook插件页面的定义，通过定义插件所包含的组件，会通过读取json来渲染到插件页面上

  3. 可配置参数文件（input.json）: 对于可视化工具的可配置绘图参数或通用参数进行定义，代码文件中的配置参数需读取此文件的默认配置

  4. 代码文件(plot.R)：可以是Python也可以是R文件，通过定义代码文件，可将用户在插件页面上的配置通过代码运行产生输出结果

  5. 示例图片：每个插件都会有一个示例图片，方便用户理解此插件

  6. 示例数据：方便用户测试插件功能，该插件的示例数据

输入文件说明及示例

metadata文件

metadata文件主要是用于介绍此工具的基本信息。

636B
meta.json

meta.json文件中目前有以下几个字段需要关注

  1. name：代表当前工具名称

  2. sample_img ：会读取这个字段的图片参数作为示例图片

  3. sample_data_file：会读取这个字段的参数作为示例数据

  4. output_img：会读取这个字段的参数作为notebook输出图片

  5. main：运行的代码主文件

  6. run：执行文件

UI文件

对于交互式页面的ui定义 , json文件中字段参数对应工具页面参数如下

  • data：数据文件

  • columns：数据参数

  • General：通用参数

  • Plotsetting: 绘图参数

示例文件:

2KB
ui.json

输入参数文件

用于指定工具可配置的输入参数 ，输入参数中的columns、general、plotsetting对应ui见面参数中的columns、general、plotsetting，示例文件如下：

568B
input.json

代码文件

核心的执行文件, BioMate中工具的核心执行文件，该代码中工具所用到的参数需配置在输入参数文件中才能保证工具的参数可调。此处以韦恩图工具代码作为示例。

6KB
venndiagram.r

示例图片

每个工具需要配一个示例图片，主要用于工具界面左侧的示例图。如韦恩图的示例作图为例。

示例数据

每个工具都需要有示例数据，示例数据有助于帮助用户在Notebook中插入工具时，对工具的参数进行测试并使用示例数据生成图形，不同的工具可能示例数据不同，示例数据可以是txt也可以是csv，您可以通过编辑核心代码中的数据读取逻辑进行自定义。此处示例为韦恩图示例工具中采用的示例数据。

2KB
testData.csv

如何在Notebook中测试代码是否可运行

  1. 完成核心代码、输入参数文件编写（可参照前述示例代码）

a. 代码里需要通过指定config文件也就是input.json, 并从中获取字段并作为代码输入参数，如下图中通过获取input.json中title字段传入右侧veen.diagram方法中（config$general$title）

在代码中用到的参数

b. 需要读取对应的数据文件

  1. 准备好测试用数据(测试数据参考前文中额示例数据)

  2. 上传文件到Notebook存储目录中如下图所示

  1. 运行代码

Rscript volcanoPlot.r plot --config input.json --output 方案1.jpg

可视化工具与 bioMate 集成测试

前置准备：

  1. 本地安装，可参看jupyterlab官方文档https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html

  2. 如果你的代码中有R代码，确保本地有R环境

  3. 已安装 bio_mate jupyterlab 扩展，安装方式可在jupyterlab命令行执行 pip install -i https://test.pypi.org/simple/ bio-mate==0.1.0

  1. 将待测试的可视化工具文件夹，整体复制到 bio_mate/plot-defs 文件夹下，并重命名为 myplot，如下图所示：

bio_mate 文件夹位置，可通过下图方式获取。或通过 find / -name plot-defs 命令，直接找到 plot-defs 文件夹。

  1. 重启 ipython kernel，刷新浏览器，使得 bio_mate 初始化 myplot 模块

  1. 在 notebook 中执行下述语句，触发渲染 myplot 模块，检查各参数渲染是否正确。

  1. 点击【生成】按钮，进行图形生成，检查图形生成是否正常，可通过点击 【查看执行日志】，做进一步问题排查。尝试修改各参数参数值，再次生成，检查参数调整是否生效。

  2. 上述步骤全部调试通过，即完成与 bio-mate 集成工作 🎉。

PreviousFor Bio-OS开发者

Last updated