colonyzer.read: Reads raw cell density timecourse data from Colonyzer output files

Description

Reads in and binds together all of the Colonyzer output files in a directory, so they are checked and ready for bayesian or likelihood inference. Colonyzer is an open source image analysis tool for quantifying cell densities on agar plates: http://research.ncl.ac.uk/colonyzer/

Usage

1
2
colonyzer.read(path=".",files=c(),experiment="ExptDescription.txt",
ORF2gene="",libraries="LibraryDescriptions.csv",screenID="")

Arguments

path

The path to the folder containing the Colonyzer .dat files to be read: working directory by default.

files

Character vector giving locations of Colonyzer .dat files to be read - overrides path

experiment

Name of text file describing the inoculation times, library and plate number for unique plates. Taken relative to path if specified. File must be a tab-delimited text file with no header containing the following columns:

  • Image.Name - Full name at image capture (includes barcode and date-time) of image from which data are derived

  • Row - Row number (counting from top of image) of culture in rectangular gridded array

  • Col - Column number (counting from left of image) of culture in rectangular gridded array

  • X.Offset - x-coordinate of top left corner of rectangular tile bounding culture (number of pixels from left of image)

  • Y.Offset - y-coordinate of top left corner of rectangular tile bounding culture (number of pixels from top of image)

  • Area - Culture area (pixels)

  • Trimmed - Integrated Optical Density, sum of pixel intensities within culture area

  • Threshold - Global pixel intensity threshold used for image segmentation (after lighting correction)

  • Intensity - Total pixel intensity for square tile containing culture

  • Edge Pixels - Number of pixels classified as culture on edge of square tile

  • Colony.Color.R - Culture red channel intensity

  • Colony.Color.G - Culture green channel intensity

  • Colony.Color.B - Culture blue channel intensity

  • Background.Color.R - Background red channel intensity (for current tile)

  • Background.Color.G - Background green channel intensity (for current tile)

  • Background.Color.B - Background blue channel intensity (for current tile)

  • Edge.length - Number of culture pixels classified as being microcolony edge pixels (useful for classifying contaminants in cultures grown from dilute inoculum)

  • Tile.Dimensions.X - Culture tile width (pixels)

  • Tile.Dimensions.Y - Culture tile height (pixels)

  • Growth - Default measure of cell density (direct copy of one of Trimmed, Threshold or Intensity)

  • Barcode - Unique plate identifier

  • Date.Time - Timestamp of image capture (extracted from image filename)

  • Inoc.Time - User specified date and time of inoculation (specified in ExptDescription.txt file)

  • Treatments - Conditions applied externally to plates (e.g. temperature(s) at which cultures were grown, UV irradiation applied, etc.)

  • Medium - Nutrients/drugs in plate agar

  • Screen.Name - Name of screen (identifies biological repeats, and experiment)

  • RepQuad - Integer identifying which of the quadrants of a 1536 plate were used to inoculate the current 384 plate (set equal to 1 for all cultures for 1536 format for example)

  • MasterPlate Number - Library plate identifier

  • Timeseries order - Sequential photograph number

  • Library.Name - Name of library, specifying particular culture location

  • ORF - Systematic, unique identifier for genotype in this position in arrayed library

  • Gene - Standard gene name for genotype in this position in arrayed library. Note that this can be set equal to ORF for example

  • ScreenID - Unique identifier for this QFA screen

  • Client - Client for whom screen was carried out

  • ExptDate - A representative/approximate date for the experiment (note that genome-wide QFA screens typically take weeks to complete)

  • User - Person who actually carried out screen

  • PI - Principal investigator leading project that screen is part of

  • Condition - The most important defining characteristic of screen, as specified by user (e.g. the temperature screen was carried out at if screen is part of multi-temperature set of screens, or the query mutation if part of a set of screens comparing query mutations, or the drugs present in the medium if part of a set of drug screens)

  • Inoc - Qualitative identifier of inoculation type (e.g. "DIL" for dilute inoculum, "CONC" for concentrated). Used to distinguish between experiments carried out with different methods of inoculation.

  • Expt.Time - Time (days) since user-specified inoculation date (Inoc.Time) that current image was captured

ORF2gene

Path to a tab-delimited text file containing two columns (with no headers) associating unique, systematic strain identifiers (e.g. yeast ORF Y-numbers) with human readable gene names (e.g. standard names from SGD).

libraries

Tab-delimited text file describing the array strains present in each row-column coordinate of each plate in a series of rectangular arrayed libraries. Header row format is: "Library ORF Plate Row Column Notes". Columns are:

  • Library - Library identifier (e.g. SDLV1)

  • ORF - Systematic strain identifier

  • Plate - Plate number

  • Row - Row number

  • Column - Column number

  • Notes - Optional strain notes (e.g. is strain especially sick or missing?)

screenID

Unique experiment identifier (e.g. QFA00001)

Value

An R data.frame where each row corresponds to a single observation on a single colony, with the value of the growth measurement in 'Growth', and the date and time of the measurement in 'Date.Time'. Other information about the observation is stored in the other columns. Several columns returned are direct copies of Colonyzer output and mapped as follows:

Extra columns are automatically added as follows. Some of this information is derived from auxiliary files passed to the function such as the experimental description file, the orf-gene dictionary and the library description file:

Finally, as well as returning the object above, this function prints a small report to screen, summarising the data returned. This includes number of unique barcodes read, number of photos read, number of genotypes in experiment, number of unique culture observations made, a list of treatments applied, a list of media used, a list of unique screen names (e.g. replicates carried out), the plate dimensions (e.g. 1536, 384 or 96 format) and a list of unique inoculation dates.


Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

All documentation is copyright its authors; we didn't write any of that.