ecl-logo Documentation

RestrictSamples

RestrictSamples[samples]updatedSamples

marks samples as restricted from automatic use in any of your team's experiments that request the samples' models. Samples marked as Restricted can only be used in experiments when specifically provided as input to the experiment functions by a team member.

Details

  • This function's action may be undone using UnrestrictSamples.
  • Sets the Restricted field to True for the samples.
  • Input
    Output
    General Options

Examples

Basic Examples  (4)

Indicate that a sample must be directly referenced in order to be used in experiments:

Restrict multiple samples from automatic use in experiments:

Containers may also be restricted from automatic use with this function:

Restricting containers also restricts their contents:

Additional Examples  (4)

Restricted samples have their Restricted flag set to True:

Restrict a mixed group of containers and samples from automatic use in experiments:

Use UnrestrictSamples samples to undo this function's action by unsetting the Restricted flag:

If given an empty list, returns an empty list:

Options  (1)

UpdatedBy  (1)

Specify the UpdatedBy option to indicate who is listed in the RestrictedLog: