pathwaycommons/factoid

Biofactoid

Biofactoid（biofactoid.org）是一个基于网络的系统，使作者能够捕获和分享其出版物中描述的分子水平相互作用的机器可读摘要。Biofactoid的代码库采用MIT许可证授权。

数据获取

所有贡献的通路数据均可从 [***] 免费下载，其中包含每个通路的以下格式文件：

• JavaScript对象表示法（JSON）：Biofactoid数据的原生格式，包含相互作用数据、记录本身的元数据、对应文章的元数据以及可视化数据（布局和颜色，采用Cytoscape JSON格式（Franz et al. (2016) Bioinforma. Oxf. Engl., 32, 309–311.））。
• 生物通路交换格式（BioPAX）：用于详细语义交换（Demir et al. (2010) Biotechnol., 28, 935–942.）。
• https://sbgn.github.io/%EF%BC%9A%E6%94%AF%E6%8C%81%E7%94%9F%E7%89%A9%E8%BF%87%E7%A8%8B%E5%8F%AF%E8%A7%86%E5%8C%96%E7%9A%84%E6%A0%BC%E5%BC%8F%EF%BC%88Le Novère et al. Nat. Biotechnol., 27, 735–741. (2009); van Iersel et al. (2012) Bioinforma. Oxf. Engl., 28, 2016–2021.）。

数据采用CC0许可证授权。

所需软件

• Node.js >=10
• RethinkDB ^2.3.0
• https://github.com/PathwayCommons/factoid-converters - 另见https://hub.docker.com/repository/docker/pathwaycommons/factoid-converters/
  • 当NODE_ENV = production时，需为此实例设置BIOPAX_CONVERTER_URL配置变量

若不使用Docker时图数据库所需软件

• Neo4j ^5.4.0
• APOC ^5.4.0

~/neo4j-community-5.X.X/conf目录下的neo4j.conf文件中需包含以下行：

server.default_advertised_address=localhost
server.default_listen_address=0.0.0.0
server.bolt.enabled=true
server.bolt.tls_level=DISABLED
server.bolt.listen_address=:7687
server.bolt.advertised_address=:7687
server.http.enabled=true
server.http.listen_address=:7474
server.http.advertised_address=:7474

配置

可使用以下环境变量配置服务器：

通用（General）

• NODE_ENV：环境模式；production（生产）或development（开发，默认）
• PORT：服务器运行端口（默认3000）
• LOG_LEVEL：最低日志级别；info（默认）、warn、error之一
• BASE_URL：用于邮件链接（例如 https://factoid.baderlab.org）
• API_KEY：用于限制新文档创建（例如 8365E63B-9A20-4661-AED8-EDB1296B657F）

定时任务（CRON）

• CRON_SCHEDULE：秒（可选）、分、时、日、月、星期
• CRON_SCHEDULE_DOCCACHE_UPDATE：文档缓存刷新计划
• DOCUMENT_CRON_UPDATE_PERIOD：连续文档定时更新调用之间的毫秒数
• DOCUMENT_CRON_STALE_PERIOD：文档上次编辑后的毫秒数（用于判定是否废弃的标准）
• GRAPHDB_CRON_REFRESH_PERIOD_MINUTES：图数据库数据刷新之间的最短时间（分钟）

数据库（Database）

• DB_NAME：数据库名称（默认factoid）
• DB_HOST：数据库主机的主机名或IP地址（默认localhost）
• DB_PORT：数据库访问端口（默认28015，RethinkDB默认端口）
• DB_USER：数据库认证用户名（默认未定义）
• DB_PASS：数据库认证密码（默认未定义）
• DB_CERT：数据库使用SSL时的本地证书文件路径（默认未定义）

下载（Downloads）

• BULK_DOWNLOADS_PATH：批量下载的相对路径
• BIOPAX_DOWNLOADS_PATH：BioPAX下载的相对路径
• BIOPAX_IDMAP_DOWNLOADS_PATH：ID映射BioPAX下载的相对路径
• EXPORT_BULK_DELAY_HOURS：延迟（批量）导出任务的周期（小时）

服务（Services）

• DEFAULT_CACHE_SIZE：每个缓存中的默认最大条目数
• REACH_URL：Reach文本挖掘端点的完整URL
• PC_URL：Pathway Commons应用的基础URL，用于搜索或链接
• BIOPAX_CONVERTER_URL：Factoid到BioPAX/SBGN转换器的URL（必填）
• GROUNDING_SEARCH_BASE_URL：https://github.com/PathwayCommons/grounding-search%E7%9A%84URL
• NCBI_EUTILS_BASE_URL：NCBI E-utilities的URL
• NCBI_EUTILS_API_KEY：NCBI E-utilities的API密钥
• INDRA_DB_BASE_URL：https://indralab.github.io/%E7%9A%84URL
• INDRA_ENGLISH_ASSEMBLER_URL：将INDRA语句组装为模型的服务URL
• SEMANTIC_SEARCH_BASE_URL：https://github.com/PathwayCommons/semantic-search%E7%BD%91%E7%BB%9C%E6%9C%8D%E5%8A%A1%E7%9A%84URL
• ORCID_BASE_URL：ORCID网站的URL
• ORCID_PUBLIC_API_BASE_URL：ORCID公共API版本的URL
• NO_ABSTRACT_HANDLING：指示如何排序缺少查询文本的文档的标签。text（默认）：从模板自动生成文本；date：按日期排序并忽略文本
• CROSSREF_API_BASE_URL：Crossref Unified Resource API的URL
• NCBI_BASE_URL：NCBI/NLM/NIH的URL
• PUBTATOR_API_PATH：PubTator3网络服务API的URL路径

演示（Demo）

• DEMO_ID：演示文档ID（默认demo）
• DEMO_SECRET：演示文档密钥（默认demo）
• DEMO_JOURNAL_NAME：演示文档的期刊名称
• DEMO_AUTHOR：演示文档的作者显示名称
• DEMO_TITLE：演示文档文章的标题
• DEMO_CAN_BE_SHARED：演示文档是否可分享（默认false）
• DEMO_CAN_BE_SHARED_MULTIPLE_TIMES：演示文档是否可多次分享（普通文档仅可分享一次；默认false）
• SAMPLE_DOC_ID：用作首页示例的文档ID（生产环境）

分享（Sharing）

• DOCUMENT_IMAGE_CACHE_SIZE：内存中缓存的图像数量
• DOCUMENT_IMAGE_PLL_LIMIT：并行生成的最大图像数量（资源密集型）
• DOCUMENT_IMAGE_WIDTH：推文卡片图像宽度
• DOCUMENT_IMAGE_HEIGHT：推文卡片图像高度
• DOCUMENT_IMAGE_PADDING：推文卡片图像周围的内边距（防止***裁剪问题）
• TWITTER_ACCOUNT_NAME：卡片上显示的***账户
• TWITTER_CONSUMER_KEY：*** API密钥
• TWITTER_CONSUMER_SECRET：*** API密钥密钥
• TWITTER_ACCESS_TOKEN_KEY：***应用密钥
• TWITTER_ACCESS_TOKEN_SECRET：***应用密钥密钥
• MAX_TWEET_LENGTH：用户可输入的分享标题最大字符数

邮件（Email）

• EMAIL_ENABLED：启用第三方邮件服务的布尔值（默认false）
• EMAIL_FROM：发送邮件的名称（默认Biofactoid）
• EMAIL_FROM_ADDR：发送邮件的地址（默认support@biofactoid.org）
• SMTP_PORT：邮件传输端口（默认587）
• SMTP_HOST：邮件传输主机（默认localhost）
• SMTP_USER：邮件传输认证用户名
• SMTP_PASSWORD：邮件传输认证密码
• EMAIL_VENDOR_MAILJET：Mailjet供应商名称
• MAILJET_TMPLID_INVITE：邀请的供应商邮件模板ID
• MAILJET_TMPLID_FOLLOWUP：跟进的供应商邮件模板ID
• MAILJET_TMPLID_REQUEST_ISSUE：请求错误通知的供应商邮件模板ID
• EMAIL_TYPE_INVITE：指示邀请邮件的名称
• EMAIL_TYPE_FOLLOWUP：指示跟进邮件的名称
• EMAIL_TYPE_REQUEST_ISSUE：指示请求错误邮件的名称
• EMAIL_SUBJECT_INVITE：邀请邮件的主题文本
• EMAIL_SUBJECT_FOLLOWUP：跟进邮件的主题文本
• EMAIL_SUBJECT_REQUEST_ISSUE：请求错误邮件的主题文本

AppSignal

• APPSIGNAL_PUSH_API_KEY：AppSignal API密钥
• APPSIGNAL_APP_NAME：此应用的名称（例如 Biofactoid）
• APPSIGNAL_APP_ENV：用于指示运行的实例（例如 master、production、unstable）

图数据库（Graph Database）

• GRAPHDB_CONN：连接字符串
• GRAPHDB_USER：认证用户名
• GRAPHDB_PASS：认证密码

生产环境必须设置的环境变量

• NODE_ENV：设为production
• BASE_URL：生产环境URL
• API_KEY：设为保密的UUID（用于管理面板）
• TWITTER_ACCOUNT_NAME：卡片上显示的***账户
• TWITTER_API_KEY：*** API密钥
• TWITTER_API_KEY_SECRET：*** API密钥密钥
• TWITTER_ACCESS_TOKEN：***应用密钥
• TWITTER_ACCESS_TOKEN_SECRET：***应用密钥密钥
• NCBI_EUTILS_API_KEY：Pathway Commons账户的API密钥
• EMAIL_ENABLED：true（启用Mailjet支持）
• SMTP_HOST：Mailjet主机名
• SMTP_USER：Mailjet账户凭证
• SMTP_PASSWORD：Mailjet密码凭证
• APPSIGNAL_PUSH_API_KEY：AppSignal API密钥
• APPSIGNAL_APP_ENV：用于指示运行的实例（例如 master、production、unstable）

运行目标

• npm start：启动服务器
• npm stop：停止服务器
• npm run build：构建项目
• npm run build-prod：为生产环境构建项目
• npm run bundle-profile：可视化 bundle 依赖
• npm run clean：清理项目
• npm run watch：监视模式（启用调试模式，自动重建，实时重载）
• npm test：运行测试
• npm run lint：检查项目代码风格
• npm run fix：修复 minor 代码风格错误（可自动修复的错误）

通过Docker运行

镜像维护在https://hub.docker.com/repository/docker/pathwaycommons/factoid%E3%80%82%E5%8F%A6%E8%A7%81https://github.com/PathwayCommons/factoid-docker-config%E3%80%82

测试

所有/test目录下的文件将由Mocha运行。可使用npm test运行所有测试，或使用mocha -g specific-test-name运行特定测试（前提：npm install -g mocha）。

测试期望RethinkDB在默认端口（28015）的localhost上运行。

包含Chai以简化测试的读写。

注意：

• Syncher.synch()为每个测试文件单独设置并命名空间。原因是测试需要能够独立运行，其他文件的Syncher.synch()调用否则会冲突。
• 每个测试文件应require('./util/conf')以简化Promise调试等。

发布版本

1. 确保测试通过：npm test
2. 确保代码风格检查通过：npm run lint
3. 使用npm version更新版本号，遵循semver规范。npm的version命令会更新package.json和git标签，注意标签使用v前缀（例如 v1.2.3）：
   • 修复bug/补丁版本：npm version patch
   • 新功能版本：npm version minor
   • 破坏性API变更：npm version major
   • 特定版本号（例如1.2.3）：npm version 1.2.3
4. 推送版本：git push origin --tags
5. https://github.com/PathwayCommons/factoid/releases/new%EF%BC%8C%E4%BB%A5%E4%BE%BFZenodo%E4%B8%BA%E6%AD%A4%E7%89%88%E6%9C%AC%E5%88%9B%E5%BB%BADOI%E3%80%82

相关软件

Factoid依赖我们维护的服务软件：

GitHub

• https://github.com/PathwayCommons/grounding-search%EF%BC%9A%E9%80%9A%E8%BF%87%E5%85%A8%E6%96%87%E6%90%9C%E7%B4%A2%E6%B6%88%E6%AD%A7%E7%94%9F%E7%89%A9%E5%AE%9E%E4%BD%93
• https://github.com/PathwayCommons/semantic-search%EF%BC%9A%E5%9F%BA%E4%BA%8E%E7%9B%B8%E4%BC%BC%E5%BA%A6%E5%AF%B9%E6%96%87%E6%9C%AC%E6%8E%92%E5%BA%8F
• https://github.com/PathwayCommons/factoid-converters%EF%BC%9A%E5%B0%86Factoid%E6%A8%A1%E5%9E%8BJSON%E8%BD%AC%E6%8D%A2%E4%B8%BA%E6%A0%87%E5%87%86%E8%AF%AD%E8%A8%80%EF%BC%88BioPAX%E5%92%8CSBGN-PD%EF%BC%89

DockerHub

• https://hub.docker.com/r/pathwaycommons/factoid
• https://hub.docker.com/r/pathwaycommons/grounding-search
• https://hub.docker.com/repository/docker/pathwaycommons/semantic-search
• https://hub.docker.com/repository/docker/pathwaycommons/factoid-converters
• https://hub.docker.com/repository/docker/pathwaycommons/rethinkdb-docker%EF%BC%9A%E5%9F%BA%E4%BA%8ERethinkDB%E7%9A%84%E9%95%9C%E5%83%8F%EF%BC%8C%E5%8C%85%E5%90%AB%E6%95%B0%E6%8D%AE%E5%BA%93%E7%AE%A1%E7%90%86%E4%BE%9D%E8%B5%96%EF%BC%88%E5%A6%82%E5%A4%87%E4%BB%BD%E5%92%8C%E6%81%A2%E5%A4%8D%EF%BC%89%E3%80%82