Metadata-Version: 2.1
Name: XICRA
Version: 1.2.0
Summary: Small RNAseq pipeline for paired-end reads
Home-page: https://github.com/HCGB-IGTP/XICRA/
Author: Jose F. Sanchez-Herrero
Author-email: jfbioinformatics@gmail.com
License: MIT License
Description: # XICRA: Small RNAseq pipeline for paired-end reads
        
        ## Description
        
        XICRA is a python pipeline developed in multiple separated modules that it is designed to take 
        paired end fastq reads, trim adapters and low-quality base pairs positions, and merge reads (R1 & R2) 
        that overlap. Using joined reads it describes all major RNA biotypes present in the samples including 
        miRNA and isomiRs, tRNA fragments (tRFs) and piwi associated RNAs (piRNAs).
        
        So far, XICRA produces a miRNA analysis at the isomiR level using joined reads, multiple software at the 
        user selection and following a standardization procedure. Results are generated for each sample analyzed and 
        summarized for all samples in a single expression matrix. This information can be processed at the miRNA or 
        isomiR level (single sequence) but also summarizing for each isomiR variant type. This information can be 
        easily accessed using the accompanied R package XICRA.stats. Although the pipeline is designed to take 
        paired-end reads, it also accepts single-end reads.
        
        ## Installation
        
        XICRA will require python v3.6 and java (we tested in openjdk 14 2020-03-17).
        
        The XICRA python pipeline is available in `pip` and also available using `conda`.
        
        XICRA depends on multiple third party software that we have listed below.
        
        ### Dependencies 
        
        Python XICRA module will install itself along some python modules dependencies (pandas, multiqc, pybedtools, biopython etc.). 
        
        But additionally, XICRA depends on third party software that we listed in the following [table](https://github.com/HCGB-IGTP/XICRA/blob/master/XICRA_pip/XICRA/config/software/soft_dependencies.csv).
        
        ### Conda environment
        
        We encourage you to install XICRA and all dependencies using the `conda` environment we created and following these instructions. 
        
        Unfortunately, a couple of executables are not available neither as a `conda` or `pip` packages. These packages are `miraligner` and `sRNAbench`. We have generated a `shell` script to retrieve and include within your `conda environment`.
        
        To create a new conda environment, install third party software, install XICRA and missing dependencies, do as follows:
        
        ```sh
        ## clone repo
        git clone https://github.com/HCGB-IGTP/XICRA.git
        
        ## create conda environemt
        conda env create -n XICRA -f XICRA_pip/devel/conda/environment.yml
        
        ## activate
        conda activate XICRA
        
        ## install latest python code
        pip install XICRA
        
        ## install missing software
        sh XICRA_pip/XICRA/config/software/installer.sh
        ```
        
        To check everything is fine, try executing the `config` module:
        ```sh
        XICRA config
        ```
        
        
        ### Python environment
        
        If you are not using a `conda` environment as you might have previously installed all dependencies, we encourage you to create a python environment containing all python modules required for XICRA. See as an example this code:
        
        ```sh
        ## create enviroment
        python3 -m venv XICRA_env
        
        ## activate it
        source XICRA_env/bin/activate
        
        ## install XICRA and dependencies
        pip install XICRA
        
        ## execute XICRA
        XICRA -h
        ```
        
        ## Documentation
        
        See a full documentation, user guide and manual in [here](https://readthedocs.org/)
        
        ## Example
        Here we include a brief example on how to use XICRA.
        
        First, we create a python environment and will install XICRA and dependencies. See example details shown before.
        Then, we can test XICRA by using an example of 100 miRNA simulated and provideded within the repository as an example of simulation.
        
        ```sh
        ## run XICRA example
        ln -s ~/BMC_bioinformatics_paper/simulation/example/reads/
        
        ## prepare reads
        XICRA prep --input reads/ --output_folder test_XICRA
        
        ## join reads
        XICRA join --input test_XICRA --noTrim
        
        ## create miRNA analysis
        XICRA miRNA --input test_XICRA --software miraligner sRNAbench
        
        ## explore results
        ls test_XICRA/report/
        ```
        
        ## License 
        MIT License
        
        Copyright (c) 2020 HCGB-IGTP
        
        See additional details [here](LICENSE)
        
        ## Citation
        Sanchez-Herrero et. al .... 2020
        
        ## Authors
        Antonio Luna de Haro (v0.1)
        
        Jose F Sanchez-Herrero (v1.0)	
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
