paulsengroup/hictk

hictk

本仓库托管__hictk__的Docker镜像：用于处理.hic和.cool文件的极速工具包。

快速参考

hictk由https://github.com/paulsengroup%E5%BC%80%E5%8F%91%E5%92%8C%E7%BB%B4%E6%8A%A4%E3%80%82

如果对hictk有疑问，请在GitHub上开启新的https://github.com/paulsengroup/hictk/discussions%E3%80%82

有用链接

• 代码仓库：https://github.com/paulsengroup/hictk
• 文档：hictk.readthedocs.io
• Dockerfile：https://github.com/paulsengroup/hictk/blob/main/Dockerfile

附加信息

Docker镜像通过GitHub Actions自动构建，当提交推送到main分支或新发布被标记时触发。

构建日志：https://github.com/paulsengroup/hictk/actions/workflows/build-dockerfile.yml

支持的标签和Dockerfile链接

• https://hub.docker.com/r/paulsengroup/hictk/tags?name=main - https://github.com/paulsengroup/hictk/blob/main/Dockerfile
• https://hub.docker.com/r/paulsengroup/hictk/tags?name=2.1.5 - https://github.com/paulsengroup/hictk/blob/v2.1.5/Dockerfile
• https://hub.docker.com/r/paulsengroup/hictk/tags?name=1.0.0 - https://github.com/paulsengroup/hictk/blob/v1.0.0/Dockerfile

镜像内容

此镜像包含hictk CLI工具，由单个二进制文件（hictk）及多个子命令组成。

快速开始

首先，从DockerHub拉取最新版本的hictk。

生产环境中，建议拉取最新稳定版本：

bash
docker pull paulsengroup/hictk:2.1.5

其他情况，可拉取最新可用镜像：

bash
docker pull paulsengroup/hictk

注意：根据操作系统不同，可能需要管理员/root权限（通常通过在拉取命令前添加sudo实现）。

打印帮助信息

console
用于处理.hic和.cool文件的极速工具。


hictk [选项] [子命令]


选项:
  -h,     --help              打印此帮助信息并退出
  -V,     --version           显示程序版本信息并退出
[选项组: 帮助]

  [最多允许以下选项之一]


选项:
  -h,     --help              打印此帮助信息并退出
          --help-cite         打印hictk的Bibtex格式引用并退出。
          --help-docs         打印hictk文档的URL并退出。
          --help-license      打印hictk许可证并退出。
          --help-telemetry    打印有关遥测收集的信息并退出。


子命令:
  balance                     使用ICE、SCALE或VC平衡Hi-C文件。
  convert                     在不同格式之间转换Hi-C文件。
  dump                        从.hic和Cooler文件读取交互数据及其他类型数据并写入stdout。
  fix-mcool                   修复损坏的.mcool文件。
  load                        从各种文本格式的交互数据构建.cool和.hic文件。
  merge                       将多个Cooler或.hic文件合并为单个文件。
  metadata                    将文件元数据打印到stdout。
  rename-chromosomes, rename-chroms 重命名Cooler文件中的染色体。
  validate                    验证.hic和Cooler文件。
  zoomify                     将单分辨率Cooler和.hic文件转换为多分辨率。

有关更多使用细节和示例，请参考官方文档。

引用

如果在研究中使用hictk，请引用以下文献：

Roberto Rossini, Jonas Paulsen, hictk: blazing fast toolkit to work with .hic and .cool files Bioinformatics, Volume 40, Issue 7, July 2024, btae408, [***]

bibtex
@article{hictk,
    author = {Rossini, Roberto and Paulsen, Jonas},
    title = "{hictk: blazing fast toolkit to work with .hic and .cool files}",
    journal = {Bioinformatics},
    volume = {40},
    number = {7},
    pages = {btae408},
    year = {2024},
    month = {06},
    issn = {1367-4811},
    doi = {10.1093/bioinformatics/btae408},
    url = {https://doi.org/10.1093/bioinformatics/btae408},
    eprint = {https://academic.oup.com/bioinformatics/article-pdf/40/7/btae408/58385157/btae408.pdf},
}

许可证

hictk本身以https://github.com/paulsengroup/hictkpy/blob/main/LICENSE%E5%8F%91%E5%B8%83%E3%80%82

然而，hictk Docker镜像基于官方https://hub.docker.com/_/ubuntu%E9%95%9C%E5%83%8F%E4%B9%8B%E4%B8%80%EF%BC%88%E5%BD%93%E5%89%8D%E4%B8%BA24.04%EF%BC%89%EF%BC%8C%E5%85%B6%E4%B8%AD%E5%8C%85%E5%90%AB%E7%9A%84%E8%BD%AF%E4%BB%B6%E5%8F%AF%E8%83%BD%E4%BB%A5%E4%B8%8D%E5%90%8C%E8%AE%B8%E5%8F%AF%E8%AF%81%E5%8F%91%E5%B8%83%E3%80%82

有关更多详情，请参考DockerHub上官方Ubuntu镜像的README：https://hub.docker.com/_/ubuntu%E3%80%82