pfb格式的python sdk
pypfb的Python项目详细描述
#：构造：pfb python sdk：构造：
python sdk来创建、探索和修改pfb（生物医学数据的可移植格式）文件。
##pfb模式
[！[元数据][1]][1]
##安装
- 来自PYPI:
`bash pip install pypfb[gen3] `
（可选的gen3依赖项增加了将gen3数据字典转换为 一个pfb文件。）
- 源代码：
`bash pipenv install `
（还添加了用于开发的dev。
##用法
###主
Usage: pfb [OPTIONS] COMMAND [ARGS]…
PFB: Portable Format for Biomedical Data.
- 命令：
- 将添加记录添加到pfb文件中。 从其他数据格式生成pfb。 做一个空白记录以便添加。 重命名重命名架构的不同部分。 显示显示pfb文件的不同部分。 将pfb转换为其他数据格式。
###显示pfb的不同部分
Usage: pfb show [OPTIONS] COMMAND [ARGS]…
Show records of the PFB file.
Specify a sub-command to show other information.
- 选项：
-i, --input FILENAME The PFB file. [default: <stdin>] -n, --limit INTEGER How many records to show, ignored for sub-commands. [default: no limit] - 命令：
- 元数据显示pfb文件的元数据。 节点显示pfb文件中的所有节点名。 schema显示pfb文件的schema。
###将Gen3数据字典转换为pfb模式
Usage: pfb from [PARENT OPTIONS] dict DICTIONARY
Convert Gen3 data DICTIONARY into a PFB file.
If DICTIONARY is a HTTP URL, it will be downloaded and parsed as JSON; or it will be treated as a local path to a directory containing YAML files.
- 父选项：
-o, --output FILENAME The output PFB file. [default: <stdout>]
###将相应数据字典的json转换为pfb
Usage: pfb from [PARENT OPTIONS] json [OPTIONS] [PATH]
Convert JSON files under PATH into a PFB file.
- 父选项：
-o, --output FILENAME The output PFB file. [default: <stdout>] - 选项：
-s, --schema FILENAME The PFB file to load the schema from. [required] --program TEXT Name of the program. [required] --project TEXT Name of the project. [required]
###创建新的空白记录
Usage: pfb make [OPTIONS] NAME
Make a blank record according to given NODE schema in the PFB file.
- 选项：
-i, --input PFB Read schema from this PFB file. [default: <stdin>]
###向pfb添加新记录
Usage: pfb add [OPTIONS] PFB
Add records from a minified JSON file to the PFB file.
- 选项：
-i, --input JSON The JSON file to add. [default: <stdin>]
###重命名pfb的不同部分（模式演化）
Usage: pfb rename [OPTIONS] COMMAND [ARGS]…
Rename different parts of schema.
- 选项：
-i, --input FILENAME Source PFB file. [default: <stdin>] -o, --output FILENAME Destination PFB file. [default: <stdout>] - 命令：
- 枚举重命名枚举。 节点重命名节点。 类型重命名类型（未实现）。
###重命名节点
Usage: pfb rename [PARENT OPTIONS] node [OPTIONS] OLD NEW
Rename node from OLD to NEW.
###重命名枚举
Usage: pfb rename [PARENT OPTIONS] enum [OPTIONS] FIELD OLD NEW
Rename enum of FIELD from OLD to NEW.
###将pfb转换为neptune（gremlin的批量加载格式）
Usage: pfb to [PARENT OPTIONS] gremlin [OPTIONS] [OUTPUT]
Convert PFB into CSV files under OUTPUT for Neptune bulk load (Gremlin).
The default OUTPUT is ./gremlin/.
- 选项：
- –gzip/–无gzip是否gzip输出。[默认：是]
##示例
pfb from dict http://s3.amazonaws.com/dictionary-artifacts/kf-dictionary/1.1.0/schema.json > ./tests/schema/kf.avro
pfb from json ./tests/data -s ./tests/schema/kf.avro –program DEV –project test > tests/pfb-data/test.avro
cat tests/pfb-data/test.avro | pfb rename node slide slide_test > tests/pfb-data/rename_test.avro
cat tests/pfb-data/test.avro | pfb rename enum state validated validated_test > tests/pfb-data/rename_test.avro
cat tests/pfb-data/test.avro | pfb show -n 1 | jq
cat tests/pfb-data/test.avro | pfb show –schema | jq
cat tests/pfb-data/test.avro | pfb to gremlin ./output/
[1]：./doc/metadata.svg
欢迎加入QQ群-->： 979659372
