flipbook 1.2.2

FlipBook

此工具提供了一种简单的方法，让您可以快速翻阅存储在您计算机上的某些目录中的图像。它还可选地显示一个表单，您可以在其中记笔记或回答有关每个图像或一组图像的问题。

示例用途

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

特性

• 使用网络浏览器以简单方式翻阅许多本地图像文件
• 爬取顶级目录以查找.png、.jpeg或.svg图像文件
• 浏览器界面：主页列出所有图像
• 浏览器界面：图像页面显示图像、一个可选的可定制表单，您可以在其中记笔记或回答有关图像的问题、下一页/上一页链接，以及可选的其他可定制信息以提供上下文
• 使用子目录来分组图像。在同一子目录中找到的任何图像都将显示在同一页面上
• 可选地生成一个静态HTML网站以公开分享您的图片和表单响应。示例 @ https://broadinstitute.github.io/StrPileups/index.html

安装

python3 -m pip install flipbook  

运行

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

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

python3 -m flipbook -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 flipbook -t /path/user_responses.xls    #  change where user responses get saved (default: flipbook_form_responses.tsv)

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

服务器启动后，打开您的网页浏览器到 http://localhost:8080 开始审阅图片。

屏幕截图

图片页面

主页

这些页面也可在 StrPileups 网站 上找到，该网站是一个由运行生成的GitHub Pages站点

python3 -m flipbook --generate-static-website

选项

• 元数据表 (-m)

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

  由于键和值被视为HTML，因此可以用于添加更复杂的信息，例如颜色、文本格式、来自其他网页的图像的 <img ..> 标签、包含外部页面整个部分的iframe等。

• 响应表 (-t)

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

  默认: flipbook_form_responses.tsv

• 自定义表单模式 (--form-schema-json)

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

• 配置文件 (~/.flipbook_config)

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

  ~/.flipbook_config

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

要查看完整的命令行选项列表，请运行

python3 -m flipbook --help

比较审阅

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

例如

python3 -m compare_form_response_tables egor_flipbook_form_responses.tsv  ben_flipbook_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/flipbook.git
cd flipbook

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