Skip to content

Frequently Asked Questions

Studies and workspaces

What counts as a study?

A study is the data generated under one research or clinical protocol. It's often the data behind a manuscript, and it should be complete enough for someone else to understand the conclusions and reanalyze the data with similar results.

Who can see my workspace?

Only the users you give access to, plus ImmPort staff when needed. A study's data stays private until the study is released. See Account and Workspace.

Can I add or remove people from my workspace?

Yes, if you're a workspace Administrator. See Workspace roles.

Can I create a workspace through the API?

No. Request one with the Workspace Request Form.

Can I reuse the same subjects in several studies?

Yes. Keep the studies in the same workspace and link existing subjects with study_design_edit → arm_2_subject, not with the subject templates again. See Sharing Subjects Across Studies.

Registering a study

Do I have to use the Study Registration Wizard?

No. The basic_study_design and protocols templates capture the same information. See Register Your Study to choose.

My study fits more than one research focus, but the wizard lets me pick only one.

Pick the closest one and ask the ImmPort Helpdesk to link the study to the others.

I don't have the final title, journal or PubMed ID yet.

Register with what you have. Add or update publication details later with the study_design_edit template; the helpdesk can help.

Can I add a preprint?

Yes. When it's published, update the details with study_design_edit.

If I give a PubMed ID, do I need to fill in the other publication fields?

No. ImmPort fills them in automatically after the study is registered.

What's the difference between Title in Study and Role in Study for personnel?

Title in Study is free text: the person's position as your team defines it. Role in Study is chosen from a list. People given the PI role are shown in the ImmPort interface.

Can I edit a protocol inside the wizard?

No. You can choose an existing protocol or upload a new one, but not edit it there.

Can I change the suggested user-defined IDs?

Yes, to anything that helps you keep track, as long as each ID is unique in the workspace. IDs are private: ImmPort replaces them with public accessions (R-11).

Which study files can I attach?

Common formats such as .pdf, .txt, .csv, .xls(x) and .doc(x), but not .zip. Typical study files include adverse events, assessments, case report forms, data dictionaries, demographics, interventions, lab results, medical history and protocol deviations.

Templates and uploads

Which templates do I need, and in what order?

Use the Template Finder. The reasoning behind the order is on Upload Order, and assay-specific steps are on Assay Workflows.

Can I upload Excel files directly?

Yes. .xlsx, tab-delimited .txt and .json are all accepted. The old .xls format isn't (R-06).

What's the largest upload?

512 MB per package through the website. For more, use IBM Aspera or the API's S3 uploads.

My data is already in GEO, SRA or another repository. Do I upload it again?

No. Submit the ImmPort metadata and link to the other repository with the Public Repositories template.

Can I edit data after it's loaded?

Study design details: yes, with study_design_edit. Anything else: contact the ImmPort Helpdesk.

Validation

How long do validation and upload take?

Usually about five minutes, longer for large or complex packages. The study shows up in ImmPort within about five minutes of the email saying the upload succeeded.

My upload failed. Where do I start?

Search for the first error message on Troubleshooting Errors and fix that first, because early errors often cause later ones. With the API, the errors come from GET .../reports/summary (API).

A field description says one thing but the validator does another.

The validator wins. For example, the subject templates mention "referencing an existing subject", but in practice they only create new subjects (R-18). If you find a mismatch, please tell the helpdesk.

Sharing

When will my study be public?

After you submit it for curation, the curation team completes its review, and your sign-off person signs off its release. ImmPort then publishes it in a monthly data release on or before the planned public release date confirmed at sign-off. See the Study Lifecycle and the Data Release Schedule.

Why was my upload rejected with \"The study is locked\"?

The study is In Curation, Awaiting Sign-off or Ready for Release, and uploads are blocked until it's back in Draft. See E-34 and the Study Lifecycle.