Skip to content

Introduction

ImmPort Data Upload Templates Use

This guide describes the structure and use of the ImmPort data upload templates. For each template, the purpose, structure (e.g. column headers), and data entry rules are described.

Each template includes a Schema Version tag. It is used by the ImmPort Data Package Validator and Upload Processing software to ensure the current version of the template is being used. The Schema version refers to the database schema structure and content (in particular the preferred terms and reference data). These version tags should not be modified by the user.

Templates can be uploaded as Excel (.xlsx), tab-delimited text (.txt) or JSON files. Template file names must match the names in the Template Catalog; they are not case sensitive, but a browser may append a suffix such as "(1)" when downloading, which prevents ImmPort from recognizing the template.

ImmPort Data Upload Packages

The ImmPort data upload workflow is intended to be incremental or modular. You can send one or a few ImmPort upload templates and associated files (e.g. protocols or results) in a data upload package ZIP archive. Or, you can send in many templates and associated files. The order of uploading templates (study before subject or subject before study?) is determined by what descriptive data is referenced within a template and therefore what dependencies exist for an uploaded template to be successfully processed. For example, successfully uploading a subject template requires that a protocol and study arm be referenced, so both the protocol and study design template need to be in the same ZIP archive as the subject template or already uploaded and processed in ImmPort. A package uploaded through the website can be up to 512 MB; see Validate and Upload for larger uploads.

ImmPort Data Model Overview

ImmPort's model for handling research data is to organize information into metadata or descriptive categories. Each category has its own template (or suite of templates). The metadata categories and their functions are as follows:

Study: Studies provide the context and organization of a research effort. Studies organize subjects into groups (e.g. arms or cohorts) based on phenotype and/or treatment. The planned visit schedule provides a guide as to the temporal relationship between samples and encounters (i.e is the sample taken before or after a treatment). If the research includes seasonally variable treatments (e.g seasonal influenza vaccine), a separate study should be created for each season.

Subjects: Subjects may be patients or animals from which samples are taken for analysis. Two templates (one for human and one for animal subjects) are available for recording subject information. Subjects are assigned to a single group (arm or cohort) within a study and may be linked to multiple studies.

Biological Samples: Describe the types of samples taken from subjects or cell culture and processed for the experiment (i.e. organs, tissue, blood, plasma, cell culture name, etc.), when the samples were taken in the course of a study and protocols used in the sample collection, processing, and/or treatment. Samples are linked to a single study.

Experiments: Describe the measurement technique of the experiment and the links to protocols used in the experiment.

Experiment Samples: The biological samples analyzed in an experiment are linked to the assay reagent, protocol and results via the experiment sample record. Several different template files are available for listing sample details for different assay approaches. An experiment sample should be linked to a single biological sample.

Treatments: Describe the experimental conditions for specific biosamples or experiment samples. Treatments link to experiment samples as well as biosamples if needed.

Protocols: Describe the methods and procedures in studies, subject recruitment/treatment, sample collection/preparation/treatment and experiments. Protocols may be PDF files, Word documents, Excel or other file types.

Reagents: Provide detailed information about the reagents used in an experiment. Since different analysis platforms employ very different reagents, several different template files are available for listing reagent details for different assay approaches.

Template File Loading Order

ImmPort loads the template files in a specified loading order that is specified below in the following table.

Template File Loading Order
protocols.txt
reagents.array.txt
reagents.elisa.txt
reagents.elispot.txt
reagents.mbaa.txt
reagents.flow_cytometry.txt
reagents.hai.txt
reagents.cytof.txt
reagents.neutralizing_antibody_titer.txt
reagents.pcr.txt
reagents.sequencing.txt
reagents.virus_neutralization.txt
reagents.hla_typing.txt
reagents.kir_typing.txt
reagents.other.txt
reagent_sets.txt
treatments.txt
basic_study_design.txt
subjectanimals.txt
subjecthumans.txt
study_design_edit.txt
adverseevents.txt
interventions.txt
assessmentpanel.txt
assessmentcomponent.txt
assessments.txt
biosamples.txt
labtestpanels.txt
labtests.txt
labtest_results.txt
experiments.txt
controlsamples.txt
standardcurves.txt
experimentsamples.flow_cytometry.txt
experimentsamples.cytof.txt
experimentsamples.gene_expression_array.txt
experimentsamples.genotyping_array.txt
experimentsamples.hla.txt
experimentsamples.image_histology.txt
experimentsamples.kir.txt
experimentsamples.mbaa.txt
experimentsamples.rna_sequencing.txt
experimentsamples.other.txt
experimentsamples.mass_spectrometry_metabolomics.txt
experimentsamples.mass_spectrometry_proteomics.txt
experimentsamples.elisa.txt
experimentsamples.elispot.txt
experimentsamples.hai.txt
experimentsamples.virus_neutralization.txt
experimentsamples.neutralizing_antibody_titer.txt
experimentsamples.qrt-pcr.txt
immuneexposure.txt
publicrepositories.txt
elisa_results.txt
elispot_results.txt
hai_results.txt
pcr_results.txt
virus_neutralization_results.txt
hla_typing.txt
kir_typing.txt
rna_seq_results.txt
mass_spectrometry_metabolomic_results.txt
mass_spectrometry_proteomic_results.txt
mbaa_results.txt
fcm_derived_data.txt
cytof_derived_data.txt

See Also