基因组数据公用API封装器

一个简单的Python封装器，用于GDC应用程序编程接口（API）

GDC API驱动GDC数据和提交门户，并提供对GDC功能的编程访问。这包括搜索、下载和提交数据和元数据。

实现的功能

• 使用GET下载单个文件
• 使用POST下载多个文件

用法

安装

pip install gdc-api-wrapper

TCGA API参考

下载单个文件

from gdcapiwrapper.tcga import Data
Data.download(uuid="uuid-file-you-wanna-download", path="/local/path", name="filename")

注意：`path`和`name`是可选的，默认情况下路径是您的当前目录，如果没有提供名称，它将以UUID作为文件名保存。

下载多个文件

from gdcapiwrapper.tcga import Data
response, filename =Data.download_multiple(uuid_list=["UUID1", "UUID2", "UUID3"], path="/local/path")

注意：`path`是可选的，默认情况下路径是您的当前目录。

TCIA API参考

获取给定系列的SOPInstanceUID列表

from gdcapiwrapper.tcia import Data
# Example for CSV, HTML, XML
response, filename = Data.sop_instance_uids(
                        series_instance_uid="uid.series.instance",
                        format_="JSON",
                        path="/local/path", 
                        name="filename"
                    )
# Example for JSON
response, json = Data.sop_instance_uids(series_instance_uid="uid.series.instance")

允许的格式：`["CSV", "HTML", "JSON", "XML"]`，默认：`JSON`。当请求`JSON`时，API不会在磁盘上保存任何json文件，返回一个内存中的json对象。

注意：`path`和`name`是可选的，默认情况下路径是您的当前目录，如果没有提供名称，它将以SeriesInstance作为文件名保存。

下载单个DICOM图像

from gdcapiwrapper.tcia import Data
response, filename = Data.download_single_image(
                        series_instance_uid="uid.series.instance",
                        sop_instance_uid="uid.sop.instance",
                        path="/local/path",
                        name="filename.dcm",
                    )

注意：path和name是可选的，默认情况下路径是您的当前目录，如果未提供name，则将使用SOPInstanceUID作为文件名保存。

下载zip文件中的图像集

from gdcapiwrapper.tcia import Data
response, filename = Data.download_series_instance_images(
                        series_instance_uid="uid.series.instance",
                        path="/local/path",
                        name="filename.zip")

注意：path和name是可选的，默认情况下路径是您的当前目录，如果未提供name，则将使用SOPInstanceUID作为文件名保存。

变更日志

0.1

• TCGA Api端点

0.2

• TCGA Apis上的错误修复
• 公开接口重构[破坏性变更]
• TCIA Api端点