BrAPI icon indicating copy to clipboard operation
BrAPI copied to clipboard

Generalise the term 'Plate' to 'Container'

Open daveneti opened this issue 2 years ago • 3 comments

There are examples where samples are grouped together in containers, which are not plates. For example, tubes, collection bags etc.

I propose renaming Plate to Container, and PlateFormat to ContainerFormat.

In Plate the naming of fields would be

    plateDbId  -> containerDbId:
        description: The ID which uniquely identifies a `Container`
        type: string
        example: a106467f
    plateName -> containerName:
      description: A human readable name for a `Container`
      type: string
      example: Plate_123_XYZ
    plateBarcode -> containerBarcode:
      description: A unique identifier physically attached to a `Container`
      type: string
      example: '11223344'

daveneti avatar Aug 02 '23 02:08 daveneti

I would suggest revising it to "SampleContainer" or something like that. Its a little more verbose, but more specific than just "container" which is very generic. When I hear "container" my mind goes "Tupperware container", "Docker container", "shipping container" in that order lol

BrapiCoordinatorSelby avatar Aug 02 '23 15:08 BrapiCoordinatorSelby

I agree, we will call it SampleContainer in our implementation :)

daveneti avatar Aug 04 '23 08:08 daveneti

In Sample we would need to change 'well' to something more generic. e.g. position

daveneti avatar Oct 19 '23 11:10 daveneti