JMP Clinical於 11 年前發布,專門用於分析和審查以標準化和結構化資料為中心的正在進行的臨床試驗。目的是審查人員將定期(每週或每月)接收數據進行審查,以使用預先編程的報告尋找安全性和/或有效性信號,使審查人員能夠自助服務並深入挖掘相關數據。 -要求。我們希望加快審查過程,並發現在查看靜態表格、清單和資料時可能會錯過的異常情況。
此外,該軟體的目標是減輕為審閱者產生所需數據和標準化報告的程式設計團隊的負擔。這需要大量時間來運行程式或編輯程式/腳本/宏,以滿足審閱者的需求並頻繁進行。程式設計和生物統計學小組通常希望專注於研究特有的數據和報告,而不是研究與研究之間非常一致的通常表格或圖表,從而使他們能夠對研究特定的異常現象給予更強有力和更專心的關注,需要更多的統計或演算法知識。
在很大程度上,JMP Clinical 實現了這些目標,除非我們談論的是擁有許多需要監控和/或需要頻繁更新資料的研究的組織。這給資料管理和生物統計團隊帶來了新的負擔,需要更新 JMP Clinical 中的研究,或給不熟悉流程或沒有時間的審查者帶來負擔。同樣令人感興趣的是能夠修改 JMP Clinical 中的一些報告和/或按計劃運行相同的審核模板。對自動化和擴展 JMP Clinical 功能的需求已成為頻繁的請求。
輸入 JMP Clinical 的 API。圍繞著 JMP Clinical 6,我們引入了框架和基礎設施,使得以程式設計方式基於 API 存取常見功能/流程成為可能。在 JMP Clinical 7 中,API 已透過 JMP 腳本語言 (JSL) 發布並可用。在版本 8(最新版本)中,發布了更多功能。這篇文章不會詳細討論 API 的開發細節。相反,它側重於它們的實際使用,以便您可以利用它們。
我將分享一系列有關如何呼叫和使用 API 的文章。我們從簡單的開始介紹基本文法及其用法。然後我們在使用 JSL 時進一步進行更複雜的用途。最後,我們將在某些 JSL 中呼叫的兩類 API 結合起來。
對於不熟悉 JMP Clinical 背景下的術語「研究」、「回顧」、「報告」和「回顧範本」的人,請參閱此連結以熟悉這些術語。另外,那些不熟悉 JSL 的人應該閱讀此連結並了解更多。要了解 API 的使用,需要了解兩者。
對於這篇文章,讓我們從兩個主要類別和可能的內容開始。兩個主要類別是:研究管理相關功能 (JMPClinicalStudyManagerAPI) 和審查相關功能 (JMPClinicalReviewAPI)。這個想法是複製使用者介面(主要是單擊按鈕)中可以完成的操作,其中不需要使用者做出決定(例如使用新資料刷新研究的元資料或打開審核模板並為特定研究運行它)。以下是一些突出顯示與“研究管理”部分和“審查”部分相關的按鈕的圖像。
Study Management Functions that Relate to JMPClinicalStudyMangerAPIStudy Management Functions that Relate to JMPClinicalStudyMangerAPIStudy Management Functions that Relate to JMPClinicalStudyMangerAPIStudy Management Functions that Relate to JMPClinicalStudyMangerAPI與 JMPClinicalStudyMangerAPI 相關的研究管理功能
Review/Review Builder Functions that Related to JMPClinicalReviewAPIReview/Review Builder Functions that Related to JMPClinicalReviewAPIReview/Review Builder Functions that Related to JMPClinicalReviewAPIReview/Review Builder Functions that Related to JMPClinicalReviewAPI與 JMPClinicalReviewAPI 相關的審閱/審閱建構器函數
此 API 旨在執行例行任務並使其自動化,例如使用新元資料刷新研究或在審核範本內的報告中新增/刪除內容。以下是JMPClinicalStudyManagerAPI函數的連結和JMPClinicalReviewAPI函數的另一個連結以供參考。
那麼,這個 JMPClinicalStudyMangerAPI API 能為我們做些什麼呢?它為我們提供了兩組函數:獲取函數(獲取研究資訊的函數)和操作函數(新增、刪除或更新研究的函數)。下表列出了呼叫該函數的基本語法的可能性。冒號 (:) 分隔 API 呼叫和函數呼叫。一些函數具有輸入和/或返回。有關預期輸入和返回內容的詳細信息,請參閱上面的連結。
|
研究管理API
|
|
取得資訊功能
|
操弄研究功能
|
|
取得研究名稱清單:
JMPClinicalStudyManagerAPI:getStudyList
|
新增研究:
JMPClinicalStudyManagerAPI:addStudy
|
|
取得SDTM資料夾路徑:
JMPClinicalStudyManagerAPI:getSDTMFolder
|
刷新研究元資料:
JMPClinicalStudyManagerAPI:refreshStudies
|
|
取得 ADaM 資料夾路徑:
JMPClinicalStudyManagerAPI:getADaMFolder
|
刪除研究:
JMPClinicalStudyManagerAPI:刪除研究
|
|
新增獲取日期研究:
JMPClinicalStudyManagerAPI:getInitialDate
|
使用新快照更新研究:
JMPClinicalStudyManagerAPI:更新快照
|
|
取得日期 研究最新更新時間:
JMPClinicalStudyManagerAPI:getLastUpdatedDate
|
更改研究資料資料夾:
JMPClinicalStudyManagerAPI:changeFolders
|
|
取得快照啟用狀態:
JMPClinicalStudyManagerAPI:getEnableSnapshot
|
預先計算病患檔案資料:
JMPClinicalStudyManagerAPI:預計算ProfileData
|
|
取得快照編號:
JMPClinicalStudyManagerAPI:getSnapshotNumber
|
|
|
取得已識別的網域清單:
JMPClinicalStudyManagerAPI:getDomainList
|
|
|
取得磁碟上的檔案大小:
JMPClinicalStudyManagerAPI:getSizeOnDisk
|
|
|
取得建立/新增研究的 Windows 作業系統使用者 ID:
JMPClinicalStudyManagerAPI:getCreatedBy
|
|
|
取得上次更新 Study 的 Windows 作業系統使用者 ID:
JMPClinicalStudyManagerAPI:getLastUpdatedBy
|
|
現在讓我們來看看第二類,審閱功能。該函數還具有一組獲取和操作函數,但用於評論和報告。
|
審核API
|
|
取得資訊功能
|
操縱報告/審查功能
|
|
取得評論產生器的參考:
JMPClinicalReviewAPI:getReviewBuilder
|
關閉評論產生器:
JMPClinicalReviewAPI:closeReviewBuilder
|
|
取得評論檢視者/建構者 ID 和標題:
JMPClinicalReviewAPI:getReviewViewerIDsAndTitles
|
開啟評論範本:
JMPClinicalReviewAPI:openReviewTemplate
|
|
取得評論檢視器的參考:
JMPClinicalReviewAPI:getReviewViewer
|
將報告新增至審閱產生器:
JMPClinicalReviewAPI:addReport
|
|
取得審閱檢視器/生成器的目錄:
JMPClinicalReviewAPI:getReviewTableOfContents
|
按標題刪除報表審閱產生器:
JMPClinicalReviewAPI:removeReportByReportTitle
|
|
取得報告 ID 清單:
JMPClinicalReviewAPI:getReportIDList
|
在審閱產生器中按標題執行報表:
JMPClinicalReviewAPI:runReportByReportTitle
|
|
取得報告標題清單:
JMPClinicalReviewAPI:getReportTitleList
|
在審閱產生器中執行所有報表:
JMPClinicalReviewAPI:manAllReports
|
|
按 ID 取得報告的引用:
JMPClinicalReviewAPI:getReportByID
|
將審閱產生器內容儲存為審閱:
JMPClinicalReviewAPI:儲存評論
|
|
按標題取得報告參考:
JMPClinicalReviewAPI:getReportByTitle
|
在審閱檢視器中開啟審閱:
JMPClinicalReviewAPI:openReview
|
|
按標題取得報告詳細資訊:
JMPClinicalReviewAPI:getReportDetailsByTitle
|
將部分插入報告:
JMPClinicalReviewAPI:insertSectionIntoReportByTitleAndSectionName
|
|
取得報告結果的參考:
JMPClinicalReviewAPI:getReportResultsByTitle
|
從報告中刪除部分:
JMPClinicalReviewAPI:removeSectionFromReportByTitleAndSectionName
|
|
取得報告部分的參考:
JMPClinicalReviewAPI:getReportSectionByTitleAndSectionName
|
新增到報告部分的末尾:
JMPClinicalReviewAPI:appendDisplayObjectToReportSectionByTitleAndSectionName
|
|
取得報表中使用的資料表清單:
JMPClinicalReviewAPI:getDataTablesForSectionByTitleAndSectionName
|
加入到報告部分的開頭:
JMPClinicalReviewAPI:prependDisplayObjectToReportSectionByTitleAndSectionName
|
現在我們列出了不同的功能及其功能。現在是時候展示它們使用的基本語法了。基本形式是這樣的:
JMPClinical<CATEGORY>應用程式介面:<FUNCTION> ({參數}, {命名空間},completeListenerFunction());</FUNCTION></CATEGORY>
我在上面提到JMPClinicalStudyManagerAPI時已經介紹了Study Management相關API函數的基本呼叫。因此,如果我想刷新已註冊研究的元數據,它將如下所示:
JMPClinicalStudyManager:refreshStudies ({studyList},{},{});
我們將在下一組帖子中對此進行更多剖析並討論常見用途。現在,我想介紹可用的內容以及如何在 JSL 腳本中呼叫它。下一篇文章將介紹研究管理 API 的範例,詳細討論 API 呼叫的命名空間和completeListener 部分,並開始將其包裝在 JSL 中以及在其中使用 JSL。
在下一篇文章之前,請保重!
你好,Chris,我想知道是否有研究管理 API 可以將一項研究作為 JMP 臨床中的當前研究。 在您博客的表格中找不到它。非常感謝。 李寶月
@BaoyueLi,
這麼晚才回覆很抱歉。我在這篇文章中沒有看到這個評論。在 JMP Clinical 18(和 17)中,您可以設定當前研究。以下是使用者指南中 API 頁面的連結:
https://www.jmp.com/support/downloads/JMPC180_documentation/Content/JMPCUserGuide/AP_C_0013.htm
這是它的一般用法:
JMPClinicalStudyManagerAPI:setCurrentStudy("研究名稱")
將目前研究設定為指定的研究。
論據:
Study - 包含要設定為目前研究的研究名稱的字串,或 Empty() 將目前研究設定為
退貨:
如果當前研究成功設置,1;否則為 0。
謝謝克里斯。似乎“setCurrentStudy”命令在 JMP 臨床版本 15 中不可用?