#
Submitting Assay Data and Metadata
Data Submission Introduction provides a general overview for submitting data and metadata to HTAN. This page provides details regarding those steps.
#
Data Submission Steps
Complete Pre-submission Tasks Submit Data Files Submit Metadata
Please read the rest of this page for more information about each of these steps.
#
Pre-submission Tasks
- Have at least one user with Certified User status on Synapse.
To upload files to the Synapse Platform, you need to be a Synapse Certified User. You can complete your certification by taking a short certification quiz. Please see the Synapse Certified User Documentation for more information. Please also be aware that use of Synapse requires agreement to the latest Synapse Terms of Service. Synapse users must also enable two-factor authentication (2FA). You can find information about the latest TOS and guidance on enabling 2FA on your account here.
- Contact your Data Liaison
When you are ready to upload data, please contact your data liaison. Please have users obtain certified user status prior to contacting your data liaison.
- Ensure the dataset conforms to the HTAN Data Model and uses HTAN Identifiers.
The HTAN Data Model is built upon data standards described on the Data Model page. All HTAN Centers are required to encode their clinical, biospecimen and assay data and metadata using the HTAN Data Model. If you have a new data type which is not currently represented in the HTAN Data Model, please contact your data liaison.
All data should be identified using HTAN identifiers. Please see the Identifiers and Creating HTAN Identifiers sections of this manual for more information regarding HTAN identifiers.
- Ensure that your data does not contain PHI.
Please review your data to ensure that it does not contain PHI. The HTAN DCC cannot accept data with PHI, including dates less than a year. For example, dates in metadata must be converted to days from an index date and all image files must have PHI removed from file headers.
#
Submit Data Files
Data files can be transferred using the Synapse User Interface (Synapse UI) or programmatically.
- To upload files using the Synapse User Interface, follow Synapse's Uploading a File (via Synapse UI) directions.
- To upload the files programmatically, please follow Synapse's Uploading a File Programmatically directions. Contributors are encouraged to use the Python client for programmatic uploads.
For large file uploads, Synapse also provides guidance regarding uploading data in bulk in this tutorial.
If you upload files to Synapse programmatically using the python client, please use synapseclient version 3.0.0 or higher.
#
Submit Metadata
Synapse provides a curator within its platform for creating and managing metadata. Please see their documenation for information about using the curator.
In the Synapse system, metadata can be File-based (associated with a data file) or Record-based. Please see Synapse's Documentation for more information about these terms.
For HTAN:
Record-based metadata includes the Clinical and Biospecimen modules of the HTAN2 Data Model.
File-based metadata includes all other modules in the HTAN2 Data Model.
#
Useful Links and Guides
#
Synapse
#
Understanding the HTAN Data Model
- To understand the general structure of the HTAN Data Model and HTAN Identifiers, please see the HTAN Data Model section of this manual.
- The Data Model is implemented and available publicly in github.