Additional information
Technical details
RnaChipIntegrator has been tested against the following versions of
Python:
3.5
3.6
3.7
3.8
3.9
It requires the external xlsxwriter library in order to generate the
.xlsx Excel spreadsheets:
This library will be installed automatically if using pip.
The source code for the program is hosted on GitHub at
The devel branch holds the developmental code and can be installed
directly from GitHub using pip:
pip install git+https://github.com/fls-bioinformatics-core/RnaChipIntegrator.git@devel
The unit tests for the code can be run using:
python setup.py test
(Note that this requires the nose package.)
Additionally there are a set of integration tests for the utility in
the examples subdirectory. These can be run by executing the
run_examples.sh script.
Both the integration and unit tests are also run on the Travis-CI continuous integration server each time a change is made to the code; the test results can be found at https://travis-ci.org/fls-bioinformatics-core/RnaChipIntegrator/
Documentation
The documentation under the docs subdirectory is generated using the
sphinx package, and can be built by doing either:
python setup.py sphinx_build
or:
cd docs
make html
both of which create the documentation in the docs/_build
subdirectory.
A copy of the documentation is also hosted on ReadTheDocs at http://rnachipintegrator.readthedocs.io/en/latest/
Credits
RnaChipIntegrator was written by Peter Briggs, Ian Donaldson
and Leo Zeef in the Bioinformatics Core Facility (BCF) in the
Faculty of Life Sciences, University of Manchester, with
additional contributions from Casey Bergman.
Licensing
This software is licensed under the Artistic License 2.0; see
the LICENSE document.
Version history and changes
See the CHANGELOG.