SampleUsage

SampleUsage[primitives]⟹table

creates a table containing the usage amount, the amount in the user's inventory, and the amount in the public inventory for all samples specified in primitives.

Details

The amount of each sample in the public inventory is a total amount of all samples sharing the same model as the sample of interest that are not part of any Notebooks.
The initial amount of each sample in the user's inventory is a total amount of all samples sharing the same model as the sample of interest that are part of Notebooks financed by the user's financing teams.
The final amount of each sample in the user's inventory is a predicted remaining amount if the provided manipulations were performed.

Input

Output

General Options

Examples

Basic Examples (3)

Display the usage amount for each sample or model object used in the specified manipulations as a Table:

Display the amount of all samples in your inventory and the public inventory that share the same model as the samples specified in the primitives, and the predicted remaining amount in your inventory if the manipulations were performed:

Display the usage amount for each sample or model object with defined names used in the specified manipulations as a Table:

Additional Examples (1)

Display the usage amount for each sample or model object used in the specified manipulations as a list of Associations:

Options (5)

Author (1)

The amount in the user's inventory is calculated based on the specified Author:

InventoryComparison (1)

If InventoryComparison -> True, returns a table with the usage amount, the amount in the user's inventory, and the amount in the public inventory for all sample objects and models specified in the input primitives:

Messages (1)

If Messages -> False, suppresses the all the messages thrown:

OutputFormat (2)

If OutputFormat -> Table, displays a table with the usage amount for each sample or model object used in the specified manipulations:

If OutputFormat -> Association, returns a list of associations of the usage amount for each sample or model object used in the specified manipulations:

Messages (16)

DeprecatedSpecifiedModels (1)

Throw a warning message for any input primitive that contains sample models that are deprecated:

DiscardedSamples (1)

Throw a warning message for any input primitive that contains discarded samples:

ExcessDestinationVolume (1)

Throw a warning message for any FillToVolume primitive with Destination volume that exceeds FinalVolume:

ExpiredSamples (1)

Throw a warning message for any input primitive that contains samples that are expired:

FillToVolumePrimitiveIncluded (1)

Throw a warning message indicating that the usage amount displayed may not be accurate for samples used in FillToVolume primitives:

InsufficientAmount (1)

Throw a warning message for any input primitive that contains samples with insufficient amount to undergo all the specified manipulations:

InvalidAmountLength (1)

Throw a warning message for any input primitive that contains mismatched amount length:

InvalidNameReference (1)

Throw a warning message for any object defined in input primitives that does not have a valid defined name:

InvalidPrimitiveKeyValue (1)

Throw a warning message for any input primitive that contains key(s) with invalid pattern:

InvalidPrimitiveType (1)

Throw a warning message if at least one input primitive with invalid manipulation type is given:

MissingObjects (1)

Throw a warning message for any input primitive that contains samples that do not exist in the database:

NoValidObjectsToUse (1)

Throw an error message and return $Failed if there are no valid objects to use for usage amount calculation:

NoValidPrimitives (1)

Throw an error message and return $Failed if there are no valid primitives to use for usage amount calculation:

SamplesMarkedForDisposal (1)

Throw a warning message for any input primitive that contains samples marked for disposal:

SamplesNotOwned (1)

Throw a warning message for any input primitive that contains public samples that are not owned buy the user:

SamplesWithDeprecatedModels (1)

Throw a warning message for any input primitive that contains samples that have models that are deprecated: