Applications/PaCeQuantAna

2020-07-23T12:52:36Z

Poeschl:

== 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. 

'''Please note:''' 
'''The new version compatible with PaCeQuant as released in MiToBo 2.0 in May 2020 will appear soon!''' 
'''Due to implications of the Corona pandemic the release of the package update had to be postponed.''' 
'''We apologize for the inconvenience and hope to be able to make the new PaCeQuantAna release available to you very soon.'''

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 ===
For installation in RStudio download the package and follow the instructions below:

<ol>
<li> Install the following packages:
<ul>
<li> '''caroline'''
<li> '''gplots'''
<li> '''dunn.test'''
<li> '''sm'''
<li> '''RColorBrewer'''
</ul>
To this end start RStudio, select
<blockquote>“Tools” → “Install Packages…” </blockquote>
from the menu bar. Choose <blockquote>“Install from: Repository (CRAN)”</blockquote> and enter the names of the packages. Activate <blockquote>“Install dependencies”.</blockquote>
<li> The multtest package can be installed via the following Bioconductor installation script: 
<blockquote>source ("<nowiki>http://bioconductor.org/biocLite.R</nowiki>")</blockquote>
<blockquote>biocLite("multtest")</blockquote>
<li> Install the PaCeQuantAna package selecting
<blockquote>“Tools” → “Install Packages…”</blockquote>
from the menu bar. 
Choose <blockquote>“Install from: Package Archive File (.tgz; .tar.gz)"</blockquote>
and select the tar.gz file of PaCeQuantAna via <blockquote>"Browse...".</blockquote>
</ol>

=== 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
<blockquote>vignette("PaCeQuantAna")</blockquote>
in the console.

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 package on these sample data: [http://mitobo.informatik.uni-halle.de/downloads/paceQuant/time_series.zip sample data for PaCeQuantAna] 

=== Important notes ===
<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! 
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:
<blockquote>...</blockquote>
<blockquote>Error in pdf(file = paste0(outdir, fsep, base_file_name,</blockquote>
<blockquote>"_dunn_test_heatmap_adjusted_pvalues.pdf"),  :</blockquote>
<blockquote>  unknown family 'Arial'</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
<blockquote>library(extrafont)</blockquote>
This will initialize the Windows font database and should solve the problems.
</ul>