Skip to content

Commit

Permalink
made some updates to docs and preset values to replace references to …
Browse files Browse the repository at this point in the history
…target with biofeature and gene
  • Loading branch information
aschroed committed May 9, 2019
1 parent f4e3544 commit ad0db84
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 10 deletions.
19 changes: 18 additions & 1 deletion doc/metadata_submission.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,24 @@ The scripts accepts the following parameters:.

**To get the complete list of relevant sheets in one workbook:**

get_field_info --type Publication --type Document --type Vendor --type Protocol --type BiosampleCellCulture --type Biosource --type Enzyme --type Construct --type TreatmentChemical --type TreatmentRnai --type Modification --type Biosample --type FileFastq --type FileSet --type IndividualHuman --type IndividualMouse --type ExperimentHiC --type ExperimentCaptureC --type ExperimentRepliseq --type BioFeature --type GenomicRegion --type Gene --type ExperimentSet --type ExperimentSetReplicate --type Image --comments --outfile AllItems.xls
get_field_info --type all --comments --outfile AllItems.xls


**You can also generate the sheets needed for a particular type of experiment using pre-set options**

get_field_info --type hic --comments --outfile HiCMetadata.xls

Current presets include:
- hic for most types of Hi-C eg. in situ, dilution, single cell
- chipseq for ChIP-seq
- repliseq for 2-phase or multi-phase Repli-seq
- atacseq for ATAC-seq
- damid for DamID-seq
- chiapet for CHIA-Pet and PLAC-seq
- capturec for Capture Hi-C
- fish for RNA and DNA FISH
- spt for Single Particle Tracking Imaging experiments


##<a name="rest"></a>Submission of metadata using the 4DN REST API
The 4DN-DCIC metadata database can be accessed using a Hypertext-Transfer-Protocol-(HTTP)-based, Representational-state-transfer (RESTful) application programming interface (API) - aka the REST API. In fact, this API is used by the ```import_data``` script used to submit metadata entered into excel spreadsheets as described [in this document](https://docs.google.com/document/d/1Xh4GxapJxWXCbCaSqKwUd9a2wTiXmfQByzP0P8q5rnE). This API was developed by the [ENCODE][encode] project so if you have experience retrieving data from or submitting data to ENCODE use of the 4DN-DCIC API should be familiar to you. The REST API can be used both for data submission and data retrieval, typically using scripts written in your language of choice. Data objects exchanged with the server conform to the standard JavaScript Object Notation (JSON) format. Libraries written for use with your chosen language are typically used for the network connection, data transfer, and parsing of data (for example, requests and json, respectively for Python). For a good introduction to scripting data retrieval (using GET requests) you can refer to [this page](https://www.encodeproject.org/help/rest-api/) on the [ENCODE][encode] web site that also has a good introduction to viewing and understanding JSON formatted data.
Expand Down
2 changes: 1 addition & 1 deletion doc/schema_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ software.json | Software | software(s)
sop\_map.json | SopMap | sop-maps, sop\_map
summary\_statistic.json | SummaryStatistic | summary-statistics, summary\_statistic
summary\_statistic\_hi\_c.json | SummaryStatisticHiC | summary-statistics-hi-c, summary\_statistic\_hi\_c
treatment\_chemical.json | TreatmentChemical | treatments-chemical, treatment\_chemical
treatment\_agent.json | TreatmentAgent | treatments-agent, treatment\_agent
treatment\_rnai.json | TreatmentRnai | treatments-rnai, treatment\_rnai
user.json | User | user(s)
vendor.json | Vendor | vendor(s)
Expand Down
3 changes: 1 addition & 2 deletions wranglertools/4DNWranglerTools.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ Description:

*Full list*
~~~~
python3 get_field_info.py --type Publication --type Document --type Vendor --type Protocol --type ProtocolsCellCulture --type Biosource --type Enzyme --type Construct --type TreatmentChemical --type TreatmentRnai --type Modification --type Biosample --type File --type FileSet --type IndividualHuman --type IndividualMouse --type ExperimentHiC --type ExperimentCaptureC --type BioFeature --type GenomicRegion --type ExperimentSet --type Image --outfile AllItems.xls --order

python3 get_field_info.py --type all --outfile AllItems.xls
~~~~
*To get a single sheet use*
```
Expand Down
12 changes: 6 additions & 6 deletions wranglertools/get_field_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -408,18 +408,18 @@ def get_sheet_names(types_list):
else:
presets = {
'hic': ["image", "filefastq", "experimenthic"],
'chipseq': ["target", "antibody", "filefastq", "experimentseq"],
'chipseq': ["gene", "biofeature", "antibody", "filefastq", "experimentseq"],
'repliseq': ["filefastq", "experimentrepliseq", "experimentset"],
'atacseq': ["enzyme", "filefastq", "experimentatacseq"],
'damid': ["target", "filefastq", "fileprocessed", "experimentdamid"],
'chiapet': ["target", "filefastq", "experimentchiapet"],
'capturec': ["genomicregion", "target", "filefastq", "filereference", "experimentcapturec"],
'damid': ["gene", "biofeature", "filefastq", "fileprocessed", "experimentdamid"],
'chiapet': ["gene", "biofeature", "filefastq", "experimentchiapet"],
'capturec': ["genomicregion", "biofeature", "filefastq", "filereference", "experimentcapturec"],
'fish': [
"genomicregion", "target", "antibody", "microscopesettinga1", "filemicroscopy",
"genomicregion", "biofeature", "antibody", "microscopesettinga1", "filemicroscopy",
"filereference", "fileprocessed", "imagingpath", "experimentmic",
],
'spt': [
"target", "modification", "microscopesettinga2",
"gene", "biofeature", "modification", "microscopesettinga2",
"fileprocessed", "imagingpath", "experimentmic",
]}
for key in presets.keys():
Expand Down

0 comments on commit ad0db84

Please sign in to comment.