aboutsummaryrefslogtreecommitdiff
path: root/api_readme.md
diff options
context:
space:
mode:
authorzsloan2019-05-03 11:06:47 -0500
committerGitHub2019-05-03 11:06:47 -0500
commitc39a7ca68c2584c49a86fac2d05144a1b32ccd56 (patch)
tree3621302846aec4526b7328c01aa0ea6f37ae9075 /api_readme.md
parent7daf96560d0b1f945a0a5fd0aed4a9961b718635 (diff)
downloadgenenetwork2-c39a7ca68c2584c49a86fac2d05144a1b32ccd56.tar.gz
Added examples for fetching sample data & genotypes
Diffstat (limited to 'api_readme.md')
-rw-r--r--api_readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/api_readme.md b/api_readme.md
index 00ba25d7..d0102d67 100644
--- a/api_readme.md
+++ b/api_readme.md
@@ -32,6 +32,12 @@ curl http://gn2-zach.genenetwork.org/api/v_pre1/mouse/groups (for just mouse gro
[ { "DisplayName": "BXD", "FullName": "BXD RI Family", "GeneticType": "riset", "Id": 1, "MappingMethodId": "1", "Name": "BXD", "SpeciesId": 1, "public": 2 }, ... { "DisplayName": "AIL LGSM F34 and F39-43 (GBS)", "FullName": "AIL LGSM F34 and F39-43 (GBS)", "GeneticType": "intercross", "Id": 72, "MappingMethodId": "2", "Name": "AIL-LGSM-F34-F39-43-GBS", "SpeciesId": 1, "public": 2 } ]
```
+## Fetch Genotypes for Group/RISet ##
+```
+curl http://gn2-zach.genenetwork.org/api/v_pre1/genotypes/BXD
+```
+Returns a CSV file with metadata in the first few rows, sample/strain names as columns, and markers as rows. Currently only works for genotypes we have stored in .geno files; I'll add the option to download BIMBAM files soon.
+
## Fetch Datasets ##
```
curl http://gn2-zach.genenetwork.org/api/v_pre1/datasets/bxd
@@ -43,6 +49,13 @@ curl http://gn2-zach.genenetwork.org/api/v_pre1/datasets/mouse/bxd
```
(I added the option to specify species just in case we end up with the same group name across multiple species at some point, though it's currently unnecessary)
+## Fetch Sample Data for Dataset ##
+```
+curl http://gn2-zach.genenetwork.org/api/v_pre1/sample_data/HSNIH-PalmerPublish.csv
+```
+
+Returns a CSV file with sample/strain names as the columns and trait IDs as rows
+
## Fetch Individual Dataset Info ##
### For mRNA Assay/"ProbeSet" ###