审稿人2 0.9.31

reviewer #2

此工具启动一个简单的图片服务器，允许您通过网页浏览器快速浏览本地目录中的图片文件。此外，它还可选地显示一个可定制的表单，您可以在其中记笔记或回答有关每张图片或一系列图片的问题。

示例用途

• 手动编辑/审查测序数据可视化图像，例如由REViewer生成的短串联重复位点的图像
• 创建机器学习训练集
• 审查一堆照片

功能

• 通过网页浏览器以简单的方式浏览许多本地图片文件
• 爬取顶级目录以找到.png、.jpeg或.svg图像文件
• 网页界面：主页列出所有图像
• 网页界面：图像页面显示图像，一个可选的可定制表单，您可以在其中记笔记或回答有关图像的问题，下一页/上一页链接，以及可选的其他可定制信息以提供上下文
• 使用子目录对图像进行分组。同一子目录中找到的任何图像都将显示在同一页面上

安装

python3 -m pip install reviewer2  

运行

python3 -m reviewer2    # start server for all images in the current directory and subdirectories

以下是一些示例。运行--help以查看所有可用选项及其描述。

python3 -m reviewer2 -x temp -x keyword2  /path/dir-with-images    #  -x are keyword(s) of paths to skip and /path/dir-with-images is the top level dir to search instead of the current dir

python3 -m reviewer2 -t /path/user_responses.xls    #  change where user responses get saved (default: reviewer2_form_responses.tsv)

python3 -m reviewer2 -m /path/metadata.tsv          #  provide a metadata table 

服务器运行后，打开您的网络浏览器访问 http://localhost:8080 以开始审查图像。

选项

• 元数据表（-m）

  经常需要在图像页面上添加额外的信息来帮助审查，例如图像描述、质量评分等。为了启用此功能，有几种方式可以指定要添加到特定图像页面的任意键值对。第一种方法是将一个名为 reviewer2_metadata.json 的文件放在图像（们）旁边。该文件中所有键和值都将出现在该图像页面上。第二种方法是使用 -m 传递一个包含 Path 列 + 任意其他列的元数据表（.tsv 或 .xls）。如果 Path 值与包含图像（们）的相对目录匹配，则该行的条目将添加到该图像页面上。

  由于键和值被视为 HTML，因此可以使用它们添加更复杂的信息，例如颜色、文本格式化、来自其他网页的

• 响应表（-t）

  在填写图像页面顶部的表单时，响应将被写入此表。如果您稍后以相同的 -t 重新启动 reviewer2，它将重新加载以前的响应。您还可以选择使用此表提供要显示的附加列 - 有时这比使用 -m 更方便。

  默认：reviewer2_form_responses.tsv

• 自定义表单模式（--form-schema-json）

  如果您想在图像页面表单中使用非默认问题，可以指定包含自定义表单模式的 .json 文件的路径或 URL。有关预期格式的示例，请参阅 main/form_schema_examples

• 配置文件（~/.reviewer2_config）

  大多数可以通过命令行提供的设置也可以通过此 YAML 配置文件设置。例如

  ~/.reviewer2_config

  form-schema-json: /path/to/my-schema.json
  hide-metadata-on-home-page: true
  host: 127.0.0.1
  port: 8080
  

有关更多详细信息，请运行

python3 -m reviewer2 --help

比较审查

如果有2人或更多人审查相同的图像，可以使用 compare_form_response_tables 脚本来比较审查。

例如

python3 -m compare_form_response_tables egor_reviewer2_form_responses.tsv  ben_reviewer2_form_responses.tsv -o combined_responses.tsv -s1 egor -s2 ben

此脚本将打印一致性统计信息，并输出一个包含每张图像以及每个人的图像审查的 combined_responses.tsv 表。

要查看所有参数和描述的完整列表，请运行 python3 -m compare_form_response_tables --help

开发

要创建本地开发实例，请运行

git clone git@github.com:broadinstitute/reviewer2.git
cd reviewer2

# start server in dev mode so it reloads code on change
python3 -m reviewer2 /path/dir-with-images --dev-mode