Analysis Executions Overview โ
In this section, we'll cover the general flow of an analysis submission.
Execution Flow โ
- Running NCA Calculations
- Combining Results across
profiles(subjects and groups) - Creating Plots
- Generating Reports
The UI allows you to do the execution in 3 easy steps. โ
- Upload your analysis file
- Configure your inputs and optional metadata
- Execute and wait for results.
The Process โ
For those 3 easy steps to occur there are additional things that the UI does for you.
- When you log in, your JWT is returned from Cognito and "carried" around with you like a security pass.
- File uploads
- Presigned S3 File Upload requests are created, returning a
fileId - Files are securely uploaded with AWS S3 Presigned URLs
- Presigned S3 File Upload requests are created, returning a
- Configurations are preloaded with a wizard / guided input.
- Executions are submitted to the queue with:
- The uploaded file (
fileId) - The configuration
- Optional metadata
- The response returns an
executionId.
- The uploaded file (
- Using that
executionId, status checks are polled until the analysis is complete.
Tip
In this section we outline the process of uploading a file and then doing the execution. Just keep in mind that once a file is uploaded, you run multiple executions with different configurations against it.
Even better you can run them in parallel. You don't need to wait for one to complete before launching another one.
Note
Looking for the exact endpoints? See the API routes reference, organized by feature area.