<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Phaedra 2 – Concepts</title>
    <link>/2.12.0/documentation/reference_docs/concepts/</link>
    <description>Recent content in Concepts on Phaedra 2</description>
    <generator>Hugo -- gohugo.io</generator>
    <language>en-us</language>
    
	  <atom:link href="/2.12.0/documentation/reference_docs/concepts/index.xml" rel="self" type="application/rss+xml" />
    
    
      
        
      
    
    
    <item>
      <title>Documentation: Screening</title>
      <link>/2.12.0/documentation/reference_docs/concepts/screening/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.12.0/documentation/reference_docs/concepts/screening/</guid>
      <description>
        
        
        &lt;p&gt;Screening is obviously a very broad area of scientific research. In this document, we limit the scope to &lt;strong&gt;screening of plate-based carriers using digital microscopy&lt;/strong&gt;.
This means that Phaedra deals with image and/or numeric data generated by taking readouts of plates using a digital microscopy instrument.&lt;/p&gt;
&lt;h3 id=&#34;plate&#34;&gt;Plate&lt;/h3&gt;
&lt;p&gt;Plates are physical containers that have a number of &lt;strong&gt;wells&lt;/strong&gt; embedded in them. Common formats are 8x12, 16x24 and 32x48 wells per plate.
Phaedra supports arbitrary dimensions, provided that the plate has a rectangular format.&lt;/p&gt;

&lt;figure&gt;
    &lt;img src=&#34;../img/microplates.jpg&#34; width=&#34;30%&#34; height=&#34;30%&#34;/&gt; 
&lt;/figure&gt;

&lt;p&gt;Substances of interest are added into the wells, and the activity of the substances is measured either once or repeatedly by having an instrument perform
a &lt;em&gt;readout&lt;/em&gt; of the plate.&lt;/p&gt;
&lt;h3 id=&#34;experiment&#34;&gt;Experiment&lt;/h3&gt;
&lt;p&gt;An &lt;strong&gt;experiment&lt;/strong&gt; in Phaedra is simply a collection of plates. Grouping plates correctly into experiments is important for some functionality such as
&lt;em&gt;experiment-wide normalization&lt;/em&gt;, &lt;em&gt;plate polishing&lt;/em&gt; or &lt;em&gt;multiplo dose-response curve fitting&lt;/em&gt;, where data from multiple plates is taken together for calculation.
In other cases, experiments are simply a means for organizing your data efficiently.&lt;/p&gt;
&lt;h3 id=&#34;measurement&#34;&gt;Measurement&lt;/h3&gt;
&lt;p&gt;When an instrument takes a readout of a plate, the resulting dataset is called a &lt;strong&gt;measurement&lt;/strong&gt;. In Phaedra, measurements may contain up to three categories of data:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Image data&lt;/strong&gt;: images taken of each well, possibly across multiple channels (wavelengths). If multiple regions (fields) of a well are imaged, they will be stitched
together by Phaedra into a single image per well per channel. In addition, if the image analysis routine generated outline &lt;strong&gt;masks&lt;/strong&gt; or &lt;strong&gt;overlays&lt;/strong&gt;, those may be captured into the measurement as well.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Subwell data&lt;/strong&gt;: a numerical 2D dataset for each well where the rows represent &amp;ldquo;subwell items&amp;rdquo;, such as single cells. An example is the single-cell dataset generated by an image analysis routine.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Well data&lt;/strong&gt;: a numerical 2D dataset for the whole plate where the rows represent wells.&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id=&#34;substances-and-compounds&#34;&gt;Substances and Compounds&lt;/h3&gt;
&lt;p&gt;A common use case for Phaedra is to process data from small molecule or compound screening. Here, compounds are inserted into plate wells and their effects are measured
by an instrument. When such a plate is defined in Phaedra, each well may be annotated with one or more &lt;strong&gt;substances&lt;/strong&gt; such as compounds. A substance in Phaedra is always
defined by a substance &lt;strong&gt;type&lt;/strong&gt;, &lt;strong&gt;name&lt;/strong&gt; and a &lt;strong&gt;concentration&lt;/strong&gt;.&lt;/p&gt;

      </description>
    </item>
    
    <item>
      <title>Documentation: Data Model</title>
      <link>/2.12.0/documentation/reference_docs/concepts/data_model/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.12.0/documentation/reference_docs/concepts/data_model/</guid>
      <description>
        
        
        &lt;h3 id=&#34;projects-experiments-and-plates&#34;&gt;Projects, Experiments and Plates&lt;/h3&gt;
&lt;p&gt;The core entity of Phaedra, the &lt;strong&gt;plate&lt;/strong&gt;, is stored in a container entity called an &lt;strong&gt;experiment&lt;/strong&gt;. Experiments are in turn grouped into &lt;strong&gt;projects&lt;/strong&gt;.
While experiments and projects can be thought of as folders, plates are data entities with a lot of information attached to them.&lt;/p&gt;
&lt;p&gt;Nearly all of the calculations and operations that happen in Phaedra, are centered around plates.&lt;/p&gt;
&lt;p&gt;Generally speaking, plates require two pieces of data to be attached to them, before they can be fully functional:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A &lt;strong&gt;plate definition&lt;/strong&gt;, such as a linked plate layout template&lt;/li&gt;
&lt;li&gt;At least one &lt;strong&gt;measurement&lt;/strong&gt; dataset containing well data&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;In addition, you can add more data to make the plate more feature-rich and to give you a more complete insight into the plate&amp;rsquo;s data:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Well Images&lt;/strong&gt; for one or multiple channels/stainings, generated by the instrument&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Well Image overlays&lt;/strong&gt;, such as cell segmentation overlays or masks generated by the image analysis&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;SubWell data&lt;/strong&gt;, e.g. single-cell data, kinetic or time-lapse data, typically generated by the image analysis&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Tags and properties&lt;/strong&gt;, to facilitate searching through many plates or to annotate them for custom processing&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;There is no fixed order in which this data should be added to a plate: you can start by defining some blank plates and update them as
more data becomes available. The calculation and other data processing steps are typically automated via a &lt;em&gt;pipeline&lt;/em&gt; and will
execute as soon as their required pieces of data become available.&lt;/p&gt;
&lt;p&gt;Experiments are often used to represent one &lt;em&gt;batch&lt;/em&gt; or one &lt;em&gt;run&lt;/em&gt; of plate measurements. You can freely move plates between experiments (keeping in mind that
functionality like &lt;em&gt;multiplo curve-fitting&lt;/em&gt; will trigger on every change to the experiments&amp;rsquo; contents), and experiments may grow to contain dozens or even
hundreds of plates (e.g. for High-Throughput screening).&lt;/p&gt;
&lt;p&gt;Projects can also be as small or as large as you like. They can run for years, accumulating hundreds of experiments.
The main point about projects is that they are configured with a default &lt;strong&gt;pipeline&lt;/strong&gt;, which tells Phaedra which automation steps to perform on which conditions.
This means that any plate that is entered into the project, automatically becomes subject to execution by the pipeline.&lt;/p&gt;
&lt;h3 id=&#34;plate-layout-templates&#34;&gt;Plate Layout Templates&lt;/h3&gt;
&lt;p&gt;As mentioned in the previous topic, one of the essential bits of information for a plate is its &lt;strong&gt;plate definition&lt;/strong&gt;. The plate definition informs us
of the layout of the plate&amp;rsquo;s contents, such as compound samples or control wells. More precisely, a plate definition gives, for each well in the plate:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;The &lt;strong&gt;well type&lt;/strong&gt; describing the role or purpose of the well in the assay. Commonly used well types are: SAMPLE, LOW CONTROL, HIGH CONTROL, EMPTY, etc.&lt;/li&gt;
&lt;li&gt;For SAMPLE wells, the &lt;strong&gt;type&lt;/strong&gt;, &lt;strong&gt;name&lt;/strong&gt; and &lt;strong&gt;concentration&lt;/strong&gt; of the substance that is, or will be, inserted into the well.&lt;/li&gt;
&lt;li&gt;Optionally one or more annotations that can be used in further calculations.&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id=&#34;plate-measurements&#34;&gt;Plate Measurements&lt;/h3&gt;
&lt;p&gt;Whereas the plate definition provides information about the plate&amp;rsquo;s contents, which is usually available well before any readout of the plate takes place,
the plate &lt;strong&gt;measurement&lt;/strong&gt; contains data that is obtained during the readout. In many cases, this measurement data consists of &amp;ldquo;raw&amp;rdquo; data, such as TIF image
files and instrument configuration files. A &lt;strong&gt;primary analysis&lt;/strong&gt; is performed on this raw data, generating additional data such as numeric data tables.&lt;/p&gt;
&lt;p&gt;It&amp;rsquo;s important to note that Phaedra &lt;em&gt;does not&lt;/em&gt; perform primary analysis: this is typically done by the software that is bundled with the instrument.
Instead, Phaedra will take in any raw data (both images and numeric tables) and work from there to process the data and produce downstream results.&lt;/p&gt;

      </description>
    </item>
    
    <item>
      <title>Documentation: Calculation</title>
      <link>/2.12.0/documentation/reference_docs/concepts/calculation/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.12.0/documentation/reference_docs/concepts/calculation/</guid>
      <description>
        
        
        &lt;h3 id=&#34;protocols-features-and-formulas&#34;&gt;Protocols, Features and Formulas&lt;/h3&gt;
&lt;p&gt;In terms of data calculation, the &lt;strong&gt;feature&lt;/strong&gt; is the central concept that Phaedra uses. Features are grouped into &lt;strong&gt;protocols&lt;/strong&gt; which can be &lt;em&gt;executed&lt;/em&gt; on
plates to produce result data.&lt;/p&gt;
&lt;p&gt;When a protocol is executed on a plate (a process called &lt;em&gt;plate calculation&lt;/em&gt; in Phaedra), a result dataset will be generated yielding
&lt;strong&gt;one numerical value per well per feature&lt;/strong&gt;. So if a plate contains 384 wells and a protocol with 5 features is executed on it, you will end up with a resultset
containing 384 x 5 = 1920 &lt;strong&gt;feature values&lt;/strong&gt;.&lt;/p&gt;
&lt;p&gt;The &lt;strong&gt;calculation formula&lt;/strong&gt; is the most important setting of a feature. This formula may reference one or more columns from the plate measurement on which
the calculation will take place. Alternatively, a feature formula may also reference the output of &lt;em&gt;another&lt;/em&gt; feature, effectively creating a chain of calculations.
For example, a formula named &amp;ldquo;ratio A/B&amp;rdquo; might reference two columns A and B from the measurement, and calculate the ratio between them.&lt;/p&gt;
&lt;p&gt;Protocols are &lt;strong&gt;versioned&lt;/strong&gt;, and any change to the protocol (or one of its features) will cause the version number to increase. This allows you to see a precise
trail for any resultset, showing you which version of which protocol was used on which plate measurement to obtain the data you see in the resultset.&lt;/p&gt;
&lt;h3 id=&#34;pipelines&#34;&gt;Pipelines&lt;/h3&gt;
&lt;p&gt;While it is perfectly possible to manually import measurements, link them to plates, execute protocols and generate reports by hand, this can be a very time-consuming
process, especially when working on large projects and dealing with large volumes of plates.&lt;/p&gt;
&lt;p&gt;Instead, you can set up &lt;strong&gt;pipelines&lt;/strong&gt; which represent sequences of actions that will be performed automatically on any plate that comes along.
All pipeline executions are tracked, so you can see if any plate failed to process due to missing or malformed data, for example.&lt;/p&gt;
&lt;p&gt;Pipelines are defined by a sequence of &lt;strong&gt;steps&lt;/strong&gt;, usually starting with a &lt;em&gt;DataCapture&lt;/em&gt; step. Steps can be refined with &lt;strong&gt;triggers&lt;/strong&gt;, specifying the conditions that must
be met before the pipeline step will be executed.&lt;/p&gt;
&lt;p&gt;For example, suppose that you have two projects, A and B. You want each project to have its own pipeline, so that
they can each perform project-specific steps; perhaps in project A you&amp;rsquo;ll want to generate a QC report for each finished experiment and in the other you don&amp;rsquo;t.
Therefore, you define two pipelines: &lt;em&gt;pipelineWithReport&lt;/em&gt; and &lt;em&gt;pipelineWithoutReport&lt;/em&gt;.
In &lt;em&gt;pipelineWithReport&lt;/em&gt;, you configure the first step with a pattern so that it only processes measurements that have &amp;ldquo;projectA&amp;rdquo; in their name.
Accordingly, you configure a pattern in &lt;em&gt;pipelineWithoutReport&lt;/em&gt; to match all measurements with &amp;ldquo;projectB&amp;rdquo; in their name.&lt;/p&gt;

      </description>
    </item>
    
    <item>
      <title>Documentation: The User Interface</title>
      <link>/2.12.0/documentation/reference_docs/concepts/user_interface/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.12.0/documentation/reference_docs/concepts/user_interface/</guid>
      <description>
        
        
        &lt;p&gt;Phaedra&amp;rsquo;s user interface is customizable, although the overall layout is fixed:&lt;/p&gt;

&lt;figure&gt;
    &lt;img src=&#34;../img/workbench.png&#34; width=&#34;50%&#34; height=&#34;50%&#34;/&gt; 
&lt;/figure&gt;

&lt;ul&gt;
&lt;li&gt;In the top is the &lt;strong&gt;title bar&lt;/strong&gt; containing the Main Menu button and an icon representing the currently logged-in user.&lt;/li&gt;
&lt;li&gt;On the left is the &lt;strong&gt;Navigator&lt;/strong&gt;, showing a number of categories you can open and navigate into.&lt;/li&gt;
&lt;li&gt;In the center of the workbench is the &lt;strong&gt;main area&lt;/strong&gt;, where detailed information is shown for the entity you&amp;rsquo;ve navigated to.&lt;/li&gt;
&lt;li&gt;On the right is the &lt;strong&gt;side panel&lt;/strong&gt;, which is collapsed by default. This panel can be expanded to display additional views on
the current entity.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;The title bar cannot be moved, but the three main sections (left, center, right) below it can be resized by clicking and dragging
the separator bars between them.&lt;/p&gt;
&lt;h3 id=&#34;sections&#34;&gt;Sections&lt;/h3&gt;
&lt;p&gt;When displaying larger amounts of information, the main area is usually split up into multiple &lt;strong&gt;sections&lt;/strong&gt;. These sections can be recognized
by their blue color and the little white chevron on the right. Clicking on the chevron will collapse or expand the whole section.&lt;/p&gt;
&lt;h3 id=&#34;bookmarks&#34;&gt;Bookmarks&lt;/h3&gt;
&lt;p&gt;Since the Phaedra workbench is entirely browser-based, you can easily bookmark specific locations. For example, if you use the Navigator
to browse into your projects and then open &amp;ldquo;Project X&amp;rdquo; which has ID 123, you&amp;rsquo;ll note that the browser&amp;rsquo;s address bar shows something like this:&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://your.phaedra.server/project/123&#34;&gt;https://your.phaedra.server/project/123&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;Opening this URL, e.g. by clicking on it from a bookmark tab or by receiving it from a colleague by mail, will immediately open a Phaedra workbench displaying &amp;ldquo;Project X&amp;rdquo;.&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Note:&lt;/em&gt; obviously, the person opening the link may receive a login screen first to confirm their access before being able to see the project!&lt;/p&gt;

      </description>
    </item>
    
  </channel>
</rss>
