Download Results Information from Aplos NCA Analysis

Description

Retrieves download URLs and files from Aplos NCA analysis results.

Usage

aplos_download_results(url, token, execution_id)

Arguments

Value

A data frame with download URL and filename.

Examples

## Not run: 
  df <- aplos_download_results("https://api.app.aplos-nca.com", token, "exec_123")

## End(Not run)

Execute NCA Analysis in Aplos

Description

Submits and executes an NCA analysis on uploaded data.

Usage

aplos_execute_analysis(
  result,
  data_cleaning = "{}",
  analysis = "{}",
  calcs = "{}",
  plots = "{}",
  tables = "{}",
  metadata = "{}",
  url,
  token,
  name = "NCA Analysis via R",
  save_body = FALSE
)

Arguments

Value

The execution ID.

Examples

## Not run: 
  exec_id <- aplos_execute_analysis(upload_result,
  url = "https://api.app.aplos-nca.com", token = token)

## End(Not run)

Check Execution Status in Aplos NCA

Description

Polls the status of an NCA analysis execution until complete or failed.

Usage

aplos_execution_status(url, token, execution_id, sleep = 10)

Arguments

Value

The status result if succeeded, or stops with error if failed.

Examples

## Not run: 
  status <- aplos_execution_status("https://api.app.aplos-nca.com", token, "exec_123")

## End(Not run)

Fetch and Optionally Unzip Aplos NCA Results

Description

Downloads the results file from the provided download information and optionally unzips it.

Usage

aplos_fetch_results(download_info, dest_dir = "", unzip = FALSE)

Arguments

Value

The path to the downloaded file (or unzip directory if unzip=TRUE).

Examples

## Not run: 
  # Assuming status is "succeeded"
  download_info <- aplos_download_results(url, token, execution_id)
  file_path <- aplos_fetch_results(download_info, unzip = TRUE)

## End(Not run)

Obtain Aplos NCA API JWT Token

Description

Authenticates with the Aplos NCA API using AWS Cognito. This function sends a POST request to retrieve a JWT token for subsequent API calls. All API calls require a valid JWT. The JWT is only valid for a period of time (~15 minutes). Each time you make an API call with a valid JWT, that token is refreshed and the valid period is extended. Thus during a normal analysis you will only need to authenticate once as you will be making API calls within the valid time window. However, if you walk away from your computer or there is a long delay between API calls you may need to authenticate again.

Note: Store credentials securely; do not hardcode them in scripts. It is recommended that you use a hidden text file (e.g. ".aplos_creds") stored on your local computer. Read that file in and then parse it to update the required information for authentication. An example credential file may look like the following: APLOS_API_URL="https://api.app.aplos-nca.com" COGNITO_CLIENT_KEY="your_cognito_client_id/key" COGNITO_USER_NAME="your_username" COGNITO_PASSWORD="your_password" COGNITO_REGION="your_aws_region" All of this information can be found in your user profile for your Aplos NCA account under "API Settings".

Usage

aplos_get_jwt(client_id, username, password, region)

Arguments

Value

A character string containing the JWT token.

Examples

## Not run: 
  token <- aplos_get_jwt(client_id = "your_client_id", username = "user",
                         password = "pass", region = "us-east-1")

## End(Not run)

Get Presigned Upload URL for Aplos NCA

Description

Retrieves a presigned URL for uploading files to Aplos NCA.

Usage

aplos_get_upload_url(input_file, url, token)

Arguments

Value

A list with upload details.

Examples

## Not run: 
  result <- aplos_get_upload_url("path/to/file.csv", "https://api.app.aplos-nca.com", token)

## End(Not run)

Upload File to Aplos NCA

Description

Uploads a file using the presigned URL.

Usage

aplos_upload_file(input_file, result, token)

Arguments

Value

Invisible NULL. Uploads the file to the API as a side effect; throws an error if the upload fails.

Examples

## Not run: 
  aplos_upload_file("path/to/file.csv", upload_result, token)

## End(Not run)