Skip to content

Example Upload Packages

ImmPort publishes ready-made, filled-in example upload packages — the fastest way to learn the expected file layout, delimiters, and cross-file linkage (user-defined IDs) for a real submission, rather than inferring it purely from per-template field docs.

The following examples of data upload packages are provided to illustrate the organization of metadata documents and associated files in a package and how to create links between entities declared in metadata documents or referenced in ImmPort.

What's available

Package Description
Human Study Package A complete human study plus its per-assay/result sub-packages, loaded incrementally
Animal Study Package A complete animal study plus its per-assay result sub-packages
JSON Package The human study content, but templates filled out in JSON instead of tab-delimited .txt

How to use these examples

  1. Load order matters even for examples: load the base study package (example_human_study_package.zip or example_animal_study_package.zip) first; the assay sub-packages reference subjects/arms defined there by user-defined ID, and will fail foreign-key validation if loaded first.
  2. Treat these as ground-truth fixtures for format questions a field-level doc can't answer well — e.g. exact column order, how multi-valued ;-separated fields look populated, or how a result_separator_column divides metadata from result columns in a combined template file.
  3. The .txt files inside are tab-delimited — if you're generating a template programmatically, diffing your header row against the matching example file's header row is a fast sanity check before a full upload/validate round-trip.
  4. The JSON package demonstrates the JSON submission shape without needing to reverse-engineer it from the XML/requirements documents.

Not auto-updated to every schema version

These packages are maintained by the ImmPort team and migrated forward across schema versions, but there can be lag. If a field in an example package conflicts with the current Template Documentation for that template (e.g. a since-added required column), the current template documentation and validator win — the example illustrates structure and linkage patterns, not a guaranteed up-to-the-minute schema snapshot.