Applications/PaCeQuantAna: Difference between revisions

From MiToBo
Jump to navigationJump to search
No edit summary
 
(23 intermediate revisions by 2 users not shown)
Line 5: Line 5:
The new version compatible with PaCeQuant as released in MiToBo 2.0 in May 2020 is out now! It can be downloaded here:
The new version compatible with PaCeQuant as released in MiToBo 2.0 in May 2020 is out now! It can be downloaded here:


* [http://informatik.uni-halle.de/~poeschl/PaCeQuantAna/BookChapter2020/PaCeQuantAna_1.0.3.tar.gz R package v1.0.3]
* [http://www2.informatik.uni-halle.de/agprbio/mitobo/downloads/paceQuant/paceQuantAna/PaCeQuantAna_1.0.3.tar.gz R package v1.0.3]


The old version of PaCeQuantAna compatible with PaCeQuant results generated with MiToBo 1.8.x can be downloaded here:
* [http://mitobo.informatik.uni-halle.de/downloads/paceQuant/paceQuantEval/PaCeQuantAna_1.0.0.tar.gz R package v1.0.0]


=== Installation ===
=== Installation ===
Line 28: Line 24:
from the menu bar.<br> Choose <blockquote>“Install from: Repository (CRAN)”</blockquote> and enter the names of the packages.<br> Activate <blockquote>“Install dependencies”.</blockquote>
from the menu bar.<br> Choose <blockquote>“Install from: Repository (CRAN)”</blockquote> and enter the names of the packages.<br> Activate <blockquote>“Install dependencies”.</blockquote>
<li> The multtest  package can be installed via the following  Bioconductor installation script:<br>
<li> The multtest  package can be installed via the following  Bioconductor installation script:<br>
<ul> '''R versions < 3.5.0''':
  <blockquote>source ("<nowiki>http://bioconductor.org/biocLite.R</nowiki>")</blockquote>
  <blockquote>source ("<nowiki>http://bioconductor.org/biocLite.R</nowiki>")</blockquote>
  <blockquote>biocLite("multtest")</blockquote>
  <blockquote>biocLite("multtest")</blockquote>
</ul>
<ul> '''R versions >= 3.5.0''':
<ul>If you do not have used Bioconductor before and have not installed any [http://bioconductor.org/install/ Bioconductor] packages yet, then:
<blockquote>Install BiocManager and core packages from Bioconductor:
<blockquote>if (!requireNamespace("BiocManager", quietly = TRUE))</blockquote>
<blockquote>install.packages("BiocManager")</blockquote>
<blockquote>BiocManager::install()</blockquote>
</ul>
<ul>Install specific packages e.g. "multtest"
<blockquote>BiocManager::install("multtest")</blockquote>
</ul>
</ul>
<li> Install the PaCeQuantAna package selecting  
<li> Install the PaCeQuantAna package selecting  
  <blockquote>“Tools” → “Install Packages…”</blockquote>  
  <blockquote>“Tools” → “Install Packages…”</blockquote>  
Line 36: Line 45:
and select the tar.gz file of PaCeQuantAna via <blockquote>"Browse...".</blockquote>
and select the tar.gz file of PaCeQuantAna via <blockquote>"Browse...".</blockquote>
</ol>
</ol>
<br>
We use Arial or Helvetica fonts when creating the plots, which is often recommended for publication. Therefore you will need to prepare your working environment by once running <br>
<blockquote>library(extrafont)</blockquote>
<blockquote>font_import()</blockquote>
<blockquote>loadfonts()</blockquote>
This will initialize the creation of a font database.<br>
You can check which fonts where found and load by <br>
<blockquote>fonts()</blockquote>


=== Documentation ===
=== Documentation ===
Line 50: Line 67:
You can directly copy the script into a file and load this file into the Rstudio editor to run it completely or line-wise.
You can directly copy the script into a file and load this file into the Rstudio editor to run it completely or line-wise.


You can test the new version of the package with sample data and small workflows for analyses of developmental stages and mutant screening. Therefore we provide two archives:
You can test the new version of the package with sample data and small workflows (R scripts) for analyses of developmental stages and mutant screening. Therefore we provide two archives:
* [http://informatik.uni-halle.de/~poeschl/PaCeQuantAna/BookChapter2020/devStages.zip Sample data and workflow for analyses developmental stages]
 
* [http://informatik.uni-halle.de/~poeschl/PaCeQuantAna/BookChapter2020/developmentalStages.zip Sample data and R scripts for analyses of developmental stages]
 
* [http://informatik.uni-halle.de/~poeschl/PaCeQuantAna/BookChapter2020/mutantScreening.zip Sample data and R scripts for mutant screening]


Both archives contain the specific sample data, workflows and data description files. The sample data sets are reduced to 2 microscopy images per group (time point or species). The workflows contain the function calls depicted in Fig. 5 in .... The data description files are customized to fit e.g. the species and time points included in our analyses, color used or font face used.
Both archives contain the specific <br>
<ul>
<li> sample data
<li> workflows and  
<li> data description files
</ul>
.  
The sample data sets are reduced to 2 microscopy images per group (time point or species). The workflows contain the function calls depicted in Fig. 5 in Poeschl et al 2020. The data description files are customized to fit e.g. the species and time points included in our analyses, color used or font face used.<br>


You can test the package on these sample data: [http://mitobo.informatik.uni-halle.de/downloads/paceQuant/time_series.zip sample data for PaCeQuantAna]<br>
Both archives include ready to use workflows for provided sample data sets. Only the path to the folder of the extracted archive needs to be set as working directory in the corresponding R-scripts. <br>
In detail '''developmentalStages.zip''' contains
<ul>
<li> sample data: Time-series_2-3-5-7, a folder containing the data organised into folders
<li> 3 workflows: 1 general workflow for analyses of developmental stages and 2 specific workflows for
<ul>
    <li> Col-0: including prepared outputFolder containing the customised data description file
    <li> Col-0_iqd5-1_iqd5-2: including prepared outputFolder containing the customised data description file
</ul>
</ul>
<br>
In detail '''mutantScreening.zip''' contains
<ul>
<li> sample data: Mutants, a folder containing the data organised into folders
<li> 2 workflows: 1 general workflow for screening mutants and 1 specific workflow for
<ul>
    <li> mutant_screening: including prepared outputFolder containing the customised data description file
</ul>
</ul>


=== Important notes ===
=== Important notes ===
<ul>
<ul>
<li> By default the working directory (set with ''setpw(...)'') where the result folder will be created, and the data directory (set with ''setDataDir(...)'') must not be identical!<br>  
<li> By default the working directory (set with ''setwd(...)'') where the output folder will be created, and the data directory (set with ''dataDir'') must not be identical!<br>  
If you require these folders to be identical for whatever reason you need to manually edit the file ''data_description.csv'' in the output folder and delete the row referring to the output folder.
If you require these folders to be identical for whatever reason you need to manually edit the file ''data_description.csv'' in the output folder and delete the row referring to the output folder.
<li> On Windows operating systems you may encounter problems with missing fonts, i.e., error messages like the following one:
<li> On Windows operating systems you may encounter problems with missing fonts, i.e., error messages like the following one:
Line 67: Line 112:
<blockquote>&nbsp; unknown family 'Arial'</blockquote>  
<blockquote>&nbsp; unknown family 'Arial'</blockquote>  
<blockquote>...</blockquote>
<blockquote>...</blockquote>
To circumvent these problems call once in Rstudio the following two commands,
<blockquote>library(extrafont)</blockquote>
<blockquote>font_import()</blockquote>
Initialize each of your workflows using PaCeQuantAna with
Initialize each of your workflows using PaCeQuantAna with
<blockquote>library(extrafont)</blockquote>
<blockquote>library(extrafont)</blockquote>
This will initialize the Windows font database and should solve the problems.
This will initialize the Windows font database and should solve the problems.
</ul>
</ul>
<br>
===== Email =====
[[file:Email.png|left|36px|link=]]
Don't hesitate to send an email when you encounter a problem or when you have questions: [mailto:yvonne.poeschl-grau@landw.uni-halle.de yvonne.poeschl-grau@landw.uni-halle.de]<br>
<br>
=== Old versions ===
The old version of PaCeQuantAna compatible with PaCeQuant results generated with MiToBo 1.8.x can be downloaded here:
* [http://mitobo.informatik.uni-halle.de/downloads/paceQuant/paceQuantEval/PaCeQuantAna_1.0.0.tar.gz R package v1.0.0]
You can test the package on these sample data: [http://mitobo.informatik.uni-halle.de/downloads/paceQuant/time_series.zip sample data for PaCeQuantAna]<br>


<!--
<!--

Latest revision as of 07:41, 5 June 2023

PaCeQuantAna: R package for Visualization and Statistical Analysis of Cell Shape Featues

We provide an R package for visualizing and analyzing features extracted by PaCeQuant.


The new version compatible with PaCeQuant as released in MiToBo 2.0 in May 2020 is out now! It can be downloaded here:


Installation

For installation in RStudio download the package and follow the instructions below:

  1. Install the following packages:
    • caroline
    • gplots
    • dunn.test
    • sm
    • RColorBrewer

    To this end start RStudio, select

    “Tools” → “Install Packages…”

    from the menu bar.
    Choose

    “Install from: Repository (CRAN)”

    and enter the names of the packages.
    Activate

    “Install dependencies”.

  2. The multtest package can be installed via the following Bioconductor installation script:
      R versions < 3.5.0:

      source ("http://bioconductor.org/biocLite.R")

      biocLite("multtest")

      R versions >= 3.5.0:
        If you do not have used Bioconductor before and have not installed any Bioconductor packages yet, then:

        Install BiocManager and core packages from Bioconductor:

        if (!requireNamespace("BiocManager", quietly = TRUE))

        install.packages("BiocManager")

        BiocManager::install()

        Install specific packages e.g. "multtest"

        BiocManager::install("multtest")

  3. Install the PaCeQuantAna package selecting

    “Tools” → “Install Packages…”

    from the menu bar.

    Choose

    “Install from: Package Archive File (.tgz; .tar.gz)"

    and select the tar.gz file of PaCeQuantAna via

    "Browse...".


We use Arial or Helvetica fonts when creating the plots, which is often recommended for publication. Therefore you will need to prepare your working environment by once running

library(extrafont)

font_import()

loadfonts()

This will initialize the creation of a font database.
You can check which fonts where found and load by

fonts()

Documentation

Find more details of how to use the package and details about the general workflow in the vignette of the package by either navigating to the vignette in the Rstudio package manager tab or by typing

vignette("PaCeQuantAna")

in the console.

Please note:
The vignette is currently under construction. An updated version will be released soon.

The vignette contains comprehensive documentation of the various functions and options of the package.
In addition, a sample workflow R script is provided which shows all commands to load your data, configure the output and do the analysis.
You can directly copy the script into a file and load this file into the Rstudio editor to run it completely or line-wise.

You can test the new version of the package with sample data and small workflows (R scripts) for analyses of developmental stages and mutant screening. Therefore we provide two archives:

Both archives contain the specific

  • sample data
  • workflows and
  • data description files

. The sample data sets are reduced to 2 microscopy images per group (time point or species). The workflows contain the function calls depicted in Fig. 5 in Poeschl et al 2020. The data description files are customized to fit e.g. the species and time points included in our analyses, color used or font face used.

Both archives include ready to use workflows for provided sample data sets. Only the path to the folder of the extracted archive needs to be set as working directory in the corresponding R-scripts.
In detail developmentalStages.zip contains

  • sample data: Time-series_2-3-5-7, a folder containing the data organised into folders
  • 3 workflows: 1 general workflow for analyses of developmental stages and 2 specific workflows for
    • Col-0: including prepared outputFolder containing the customised data description file
    • Col-0_iqd5-1_iqd5-2: including prepared outputFolder containing the customised data description file


In detail mutantScreening.zip contains

  • sample data: Mutants, a folder containing the data organised into folders
  • 2 workflows: 1 general workflow for screening mutants and 1 specific workflow for
    • mutant_screening: including prepared outputFolder containing the customised data description file

Important notes

  • By default the working directory (set with setwd(...)) where the output folder will be created, and the data directory (set with dataDir) must not be identical!
    If you require these folders to be identical for whatever reason you need to manually edit the file data_description.csv in the output folder and delete the row referring to the output folder.
  • On Windows operating systems you may encounter problems with missing fonts, i.e., error messages like the following one:

    ...

    Error in pdf(file = paste0(outdir, fsep, base_file_name,

    "_dunn_test_heatmap_adjusted_pvalues.pdf"),  :

      unknown family 'Arial'

    ...

    Initialize each of your workflows using PaCeQuantAna with

    library(extrafont)

    This will initialize the Windows font database and should solve the problems.



Email
Email.png

Don't hesitate to send an email when you encounter a problem or when you have questions: yvonne.poeschl-grau@landw.uni-halle.de


Old versions

The old version of PaCeQuantAna compatible with PaCeQuant results generated with MiToBo 1.8.x can be downloaded here:

You can test the package on these sample data: sample data for PaCeQuantAna