23andme-node 中文文档教程

Question

23andme-node

欢迎提出请求和建议！

Index

• Installation
• Usage
• Documentation
• TODO

Installation

npm install 23andme-node

Usage

var g23 = require('23andme-node');

g23.getProfiles({token: 'fdab6a6892b198e40c2484bf2121f761'}, function (err, data) {
  console.log(utils.inspect(err || data, false, null));
});

Documentation

所有方法都返回带有签名的回调 callback(error, data)。

data 和 error 是 JavaScript 对象。

所有方法都需要一个至少具有用户身份验证 token 的 params 对象。

无论 HTTP 谓词如何，所有方法都返回相同的 data 对象。

可能的错误消息：

invalid_request - 请求缺少必需的参数，或者包含不受支持或不正确的参数。

invalid_client - 客户端身份验证失败（例如未知客户端、未包含客户端凭据、包含多个客户端凭据或不支持的凭据类型）。

unauthorized_client - 客户端无权使用此方法请求授权代码。

access_denied - 资源所有者或授权服务器拒绝了请求。

invalid_scope - 请求的范围无效、未知或格式错误。

unsupported_response_type - 授权服务器不支持使用此方法获取授权代码。

官方 API 文档。

getProfiles(params, callback(error, data))

params

• None!

data

```javascript { 名字：“格雷戈尔”， 姓氏：“孟德尔”， 编号：“a42e94634e3f7683”， 简介：[ { 名字：“约翰”， 姓氏：“孟德尔”， 编号：c4480ba411939067 }, ... ] }

## getProfileNames(params, callback(error, data))

### params

* `profileId` - Optional. Filters names to just one profile.

### data

javascript { 编号：“c4480ba411939067”， urlsize4040: "https://…cfff05bbbT.00299299.jpg", urlsize6060: "https://…cfff05bbbS.00299299.jpg", url大小200200：“https://…ff05bbbM.00299_299.jpg” }

## getProfilePictures(params, callback(error, data))

### params

* `profileId`

### data

javascript { 编号：“c4480ba411939067”， urlsize4040: "https://…cfff05bbbT.00299299.jpg", urlsize6060: "https://…cfff05bbbS.00299299.jpg", url大小200200：“https://…ff05bbbM.00299_299.jpg” }

## getPublished(params, callback(error, data))

### params

* `profileId`
* `featureId` - Values are `'music'`, `'neanderthal'`, `'maternal'`, `'paternal'`, `'composition'`
* `linkId` - Optional. Filters results to just one link.

### data

javascript { 编号：“c4480ba411939067”， 网址：“https://www.23andme.com/published/…/”， 链接id：“925v3n92424g4”， 特征id：“尼安德特人”， 状态：“未发布” }

## getIntroduction(params, callback(error, data))

### params


* `profileId`
* `matchId`

### data

javascript { 介绍： { 状态：“收到”， 可见性：“基因组”， 消息文本：“嗨！想探索吗？” }, 可以发送：false }

## getGenotypes(params, callback(error, data))

### params


* `profileId`
* `locations` - An array of SNP strings. 
* `unfiltered` - Optional. Possible values are `true` or `false`

### data

javascript { i3000001：“二”， rs3094315：“AA” 编号：“c4480ba411939067” }

## getGenomes(params, callback(error, data))

### params

* `profileID`
* `unfiltered` - Optional. Possible values are `true` or `false`

### data

javascript { 编号：“c4480ba411939067”， 基因组：“ACTAGTAG__TTGADDAAIICCTT”// …（2MB 字符串！） }

## getHaplogroups(params, callback(error, data))

### params

* `profileId`

### data

javascript { 母体终端snps：[ { rsid: "i3001424", rcrs位置：“15874” }, { rsid: "i5050411", rcrs位置：“15874” } ], 父亲终端snps：[ { "rsid": "i3000015", “snp”：“M125” } ], 产妇：“D4e2”， 父亲：“D2a1”， 编号：“c4480ba411939067” }

## getAncestry(params, callback(error, data))

### params

* `profileId` 
* `threshold` - A number in the interval (0.5, 1.0) exclusive. Default is 0.75.

### data

javascript { ID：“7ad467ea509080fb” 祖先：{ 标签：“总计”， 比例：1.0， 未分配：0.0， 子人群：[ { 标签：“撒哈拉以南非洲”， 比例：0.8227 }, { 标签： "欧洲" 比例：0.1773， 未分配：0.0193， 子人群：[ { 标签：“北欧”， 比例：0.1579， 未分配：0.0725， 亚种群：[ { 标签：“法语和德语”， 比例：0.0676 }, ... ], }, ... ] }, ... ] } }

## getNeanderthal(params, callback(error, data))

### params

* `profileId` 

### data

javascript { ID：“7ad467ea509080fb” 尼安德特人：{ 比例：0.0310， } }

## getRelatives(params, callback(error, data))

### params

* `profileId`
* `filters` - An object with properties `limit`, `offset`, `since`, `share_status`, `intro_status`.

`share_status` can have the following values: `'Owned Profile'`, `'Sharing Genomes'`, `'Public Match'`

`intro_status` can have the following values: `'Introduction Sent'`, `'Introduction Received'`, `'Introduction Accepted'`, `'Introduction Declined'`, `'Introduction Cancelled'`

### data

脚本 { 编号：“18974891hh1f3h”， 计数：10， 亲戚们： [ { 匹配id: "48f2489h294hf", 名字：“Aodh”， 姓氏：“O'Donnell”， 性别男”， 出生年份：1977 年， 出生地：“美国”， 血统：“北欧”， 家庭地点：[ "弗吉尼亚州阿灵顿", "爱尔兰劳斯郡" ], 家庭姓氏：[ “林德尔”， “迪林厄姆”， “凯莉” ], 共享片段：23， 关系：“三表哥”， 预测的关系代码：32， 用户关系代码：空， 范围：[“三表哥”，“六表哥”]， 相似度：0.24， 母体单倍群：“K1b1a1”， 父本单倍群：“G2a5”， 母方：假的， 父亲方面：是的， 注释：“我们有相同熟悉的姓氏”， 补充：1348699925， 更新：1348699975， 居住地：“北卡罗来纳州”， 介绍状态：“介绍已接受”， 共享状态：“共享基因组”， 个人资料图片网址：{ urlsize4040: "https://…cfff05bbbT.00299299.jpg", …… } }, ... ] }

## getRisks(params, callback(error, data))

### params

* `profileId`

### data

javascript { 编号：“c4480ba411939067”， 风险：[ { 描述：“心房颤动”， 报告id：“atrialfib”， 人群风险：0.2715， 风险：0.4164 }, { 描述：“前列腺癌”， 报告id：“前列腺”， 人群风险：0.1783， 风险：0.2585 }, ... ] }

## getCarriers(params, callback(error, data))

### params

* `profileId`

### data

javascript { 编号：“c4480ba411939067”， 药物反应：[ { 描述：“饮酒、吸烟和食道癌风险”， 报告id: "alcoholesophagealpgx", 状态：“典型” }, { 描述：“对丙型肝炎治疗的反应”， 报告id：“hepcpeginf_ribavirin”， 状态：“减少” }, ... ] }

## getTraits(params, callback(error, data))

### params

* `profileId`

### data

javascript { 我"d:"c4480ba411939067", 特征：[ { 描述：“肌肉表现”， 报告id：“肌肉表现”， 可能的特征：[ “可能的短跑运动员”， “不太可能的短跑运动员” ], 特征：“不太可能的短跑运动员” }, { 描述：“抵抗艾滋病毒/艾滋病”， 报告id: "hiv", 可能的特征：[ “不抗拒”， “部分抵抗” ], 特性：“不抵抗” }, ... ], } ```

postProfilePicture(params, callback(error, data))

params

• profileId
• image - A buffer.

postPublish(params, callback(error, data))

params

• profileId
• featureId - Values are 'music', 'neanderthal', 'maternal', 'paternal', 'composition'

putPublish(params, callback(error, data))

params

• profileId
• featureId - Values are 'music', 'neanderthal', 'maternal', 'paternal', 'composition'
• linkId
• status - Values are 'published' or 'unpublished'

patchIntroduction(params, callback(error, data))

params

• profileId
• matchId
• status - Possible values are 'accepted', 'rejected', 'read', 'cancelled'.
• visibility - Possible values are 'anonymous', 'profile', 'genome'

必须至少提供 status 和 visibility 之一作为参数。

patchRelatives(params, callback(error, data))

params

• profileId
• matchId
• notes - A string.
• relationshipCode

relationshipCode 的可能值：

0 你

1 同卵双胞胎

2 父亲

3 母亲

< code>4 儿子

5 女儿

6 兄弟

7 姐姐

8 同父异母兄弟

9< /code> 半姐妹

10 祖父

11 祖母

12 孙子

13 孙女

14 叔叔

15 阿姨

16 侄子

17 侄女

18 曾祖父

19 曾孙

20 曾祖母

21 曾孙女

22 曾祖父

23

曾祖母 < code>24 曾侄

25 侄孙女

26 第一个堂兄弟

27 第一个堂兄弟，一次被移除

28 第一个堂兄弟，两次被移除

29 第二代表亲

30 第二代表亲，一次移除

31 第二代堂兄弟，两次移除

32 三代表亲

33 第三代 表亲，一次被移除

34 第三个堂兄弟，两次被移除

35 第四个堂兄弟

38 第五个堂兄弟

41 第六个堂兄弟

44 远亲

TODO

• Tests