🧾

客户安装 + 激活 + 数据配置说明

适用于客户正式交付场景:安装 clinResearchKit、在 R 中完成激活、解压客户数据包、运行路径配置脚本,并完成首次自检。

📦

客户通常会收到这些文件

1. 安装包

常见示例为 clinResearchKit_1.1.4.tar.gz;如收到 Windows 二进制包,也可能是 .zip 文件。

2. 激活码

购买后收到形如 CLIN-XXXX-XXXX-XXXX 的专属激活码。

3. 客户数据包

常见命名如 20260416_clinResearchKit_customer_data_bundle.zip。如订单文件名不同,以实际交付为准。

安装 R 包 R 端激活 解压客户数据包 运行配置脚本 首次自检
1

安装 clinResearchKit

请先在 R 或 RStudio 中安装交付包,然后确认包能够正常加载。

install.packages("~/Downloads/clinResearchKit_1.1.4.tar.gz",
                 repos = NULL,
                 type = "source")

library(clinResearchKit)
packageVersion("clinResearchKit")

补充说明:如果你拿到的是 Windows 二进制包,可把 type 改为 "binary",并使用实际的 .zip 文件路径。

2

补装依赖、获取机器码并完成激活

常规流程中,激活入口在 R 中。建议先加载包、补装依赖,再运行 get_machine_id() 获取机器码并发送给管理员;收到专属激活码后,再执行 activate()

library(clinResearchKit)
install_deps()

# 第一次使用:先获取本机机器码并发送给管理员
get_machine_id()

# 收到专属激活码后再执行
activate("CLIN-XXXX-XXXX-XXXX")
check_license()

避免误解:当前标准激活口径是“本地一机一码 + R 端激活”。也就是先运行 get_machine_id(),收到专属激活码后再运行 activate()。网页侧不是默认起点,只在系统提示或管理员要求时再使用。

3

解压客户数据包并运行脚本

建议把客户数据包解压到一个长期固定的位置,再在包根目录下依次运行检查脚本和路径配置脚本。

cd ~/clinResearchKit-delivery/20260416_clinResearchKit_customer_data_bundle
Rscript analysis_code/verify_data_bundle_files.R .
Rscript analysis_code/setup_clinResearchKit_data_paths.R .

这两步分别做什么:第一步检查客户数据包内的目录与关键文件是否齐全;第二步将 NHANES、GBD、MIMIC、Elderly 四类数据路径写入本机配置。

4

在 R 中完成首次自检

完成安装、激活和路径写入后,建议立刻做一次最小自检。

library(clinResearchKit)
check_license()
show_data_paths()

nhanes_load("DEMO")
gbd_load()
conn <- mimic_connect(quiet = TRUE)
mimic_ping(conn)
elderly_load(countries = c("charls", "hrs"))

看到什么算正常:能返回激活状态、列出四类数据路径,并完成最小数据读取,就说明安装、授权与数据配置已经基本完成。

5

网页侧操作(仅在系统提示或管理员要求时使用)

当前标准流程仍是先在 R 中运行 get_machine_id(),收到专属激活码后再运行 activate()。只有在系统明确提示需要浏览器确认、订单页面提供了专属确认链接、或管理员要求处理异常迁移时,才需要进入网页侧继续操作。

当前客户数据包边界

NHANES:当前可直接用于演示与入门使用。
GBD:当前可直接用于演示与方法流程测试。
MIMIC:客户包内仅提供 synthetic demo 标准表,不等同于真实受限数据库原始交付。
Elderly:客户包内当前为标准示例数据,不表述为真实多国原始队列总库。

常见问题

源码安装时报编译错误

macOS 先运行 xcode-select --install;Windows 请先安装 Rtools。

设备占用或机器指纹不匹配

先在旧设备执行 deactivate(confirm = TRUE);如当前一机一码流程仍无法解决,请先联系管理员。只有在网页侧明确显示旧设备占用时,再登录个人中心处理。

换电脑后需要重新配置数据吗

需要。把客户数据包或数据目录迁移到新设备后,请重新执行一次路径配置脚本或重新运行 locate_data()