Package 'FaaSr'

Delete a file from local storage

Description

Deletes a file from the local FaaSr storage. This function mirrors the signature of the production FaaSr API but operates on local filesystem.

Usage

faasr_delete_file(server_name = NULL, remote_folder = "", remote_file)

Arguments

server_name	Character string specifying the server name (ignored in local implementation)
remote_folder	Character string path to the remote folder containing the file to delete
remote_file	Character string name of the remote file to delete

Value

Invisibly returns TRUE on success

Examples

## Not run: 
# Delete a file from remote storage
faasr_delete_file(remote_file = "temp_data.csv")

# Delete a file from a specific remote folder
faasr_delete_file(remote_folder = "temp", remote_file = "data.csv")

## End(Not run)

---

Get (download) a file from local storage

Description

Downloads a file from the local FaaSr storage to the local filesystem. This function mirrors the signature of the production FaaSr API but operates on local filesystem.

Usage

faasr_get_file(
  server_name = NULL,
  remote_folder = "",
  remote_file,
  local_folder = ".",
  local_file
)

Arguments

server_name	Character string specifying the server name (ignored in local implementation)
remote_folder	Character string path to the remote folder containing the file to download
remote_file	Character string name of the remote file to download
local_folder	Character string path to the local folder where the file will be saved
local_file	Character string name for the file in local storage

Value

Invisibly returns TRUE on success

Examples

## Not run: 
# Download a file from remote storage
faasr_get_file(remote_file = "data.csv", local_file = "downloaded_data.csv")

# Download to a specific local folder
faasr_get_file(remote_folder = "processed", remote_file = "data.csv",
               local_folder = "output", local_file = "data.csv")

## End(Not run)

---

List files in local storage with optional prefix

Description

Lists all files in the local FaaSr storage, optionally filtered by a prefix. This function mirrors the signature of the production FaaSr API but operates on local filesystem.

Usage

faasr_get_folder_list(server_name = NULL, faasr_prefix = "")

Arguments

server_name	Character string specifying the server name (ignored in local implementation)
faasr_prefix	Character string prefix to filter file names (optional)

Value

Character vector of file names matching the criteria

Examples

## Not run: 
# List all files in storage
files <- faasr_get_folder_list()

# List files with a specific prefix
csv_files <- faasr_get_folder_list(faasr_prefix = "data_")

## End(Not run)

---

Get the invocation ID for the current workflow

Description

Returns the invocation ID for the current workflow execution. This function mirrors the signature of the production FaaSr API but operates on local filesystem.

Usage

faasr_invocation_id()

Value

Character string invocation ID, or NULL if not available

Examples

## Not run: 
# Get current invocation ID
inv_id <- faasr_invocation_id()
if (!is.null(inv_id)) {
  cat("Invocation ID:", inv_id, "\n")
}

## End(Not run)

---

Append a log message to local logs

Description

Appends a log message with timestamp to the local FaaSr log file. This function mirrors the signature of the production FaaSr API but operates on local filesystem.

Usage

faasr_log(log_message)

Arguments

log_message

Character string message to log

Value

Invisibly returns TRUE on success

Examples

## Not run: 
# Log a simple message
faasr_log("Starting data processing")

# Log with more detail
faasr_log(paste("Processing", nrow(data), "rows of data"))

## End(Not run)

---

Put (upload) a file to local storage

Description

Uploads a file from the local filesystem to the local FaaSr storage. This function mirrors the signature of the production FaaSr API but operates on local filesystem.

Usage

faasr_put_file(
  server_name = NULL,
  local_folder = ".",
  local_file,
  remote_folder = "",
  remote_file
)

Arguments

server_name	Character string specifying the server name (ignored in local implementation)
local_folder	Character string path to the local folder containing the file to upload
local_file	Character string name of the local file to upload
remote_folder	Character string path to the remote folder where the file will be stored
remote_file	Character string name for the file in remote storage

Value

Invisibly returns TRUE on success

Examples

## Not run: 
# Upload a local file to remote storage
faasr_put_file(local_file = "data.csv", remote_file = "input/data.csv")

# Upload from a specific local folder
faasr_put_file(local_folder = "input", local_file = "data.csv", 
               remote_folder = "processed", remote_file = "data.csv")

## End(Not run)

---

Get current rank information for the executing function

Description

Returns the current rank information for the executing function in a parallel workflow. This function mirrors the signature of the production FaaSr API but operates on local filesystem.

Usage

faasr_rank()

Value

List containing Rank and MaxRank, or empty list if no rank information is available

Examples

## Not run: 
# Get current rank information
rank_info <- faasr_rank()
if (length(rank_info) > 0) {
  cat("Current rank:", rank_info$Rank, "of", rank_info$MaxRank, "\n")
}

## End(Not run)

---

FaaSr test execution

Description

Workflow execution that dynamically handles conditional branching and predecessor dependencies without precomputation.

Usage

faasr_test(json_path)

Arguments

json_path

path to workflow JSON

Value

TRUE if all functions run successfully; stops on error

---