Here, we provide a simple application case to demonstrate how to use SHAPEwarp:

1. Download and decompress the sample SHAPE reactivity profiles and the sample query files:

# Download & decompress the SHAPE reactivity profiles
$ wget https://www.incarnatolab.com/downloads/datasets/SHAPEwarp_Morandi_2022/XML.tar.gz
$ tar -xzvf XML.tar.gz 

# Download & decompress the queries
$ wget https://www.incarnatolab.com/downloads/datasets/SHAPEwarp_Morandi_2022/Queries.tar.gz
$ tar -xzvf Queries.tar.gz 


2. Prepare the SHAPEwarp database for B. subtilis ribosomal RNAs using swBuildDb:

$ swBuildDb -o Bsubtilis_rRNA_db/ XML/Bsubtilis/

A folder named "Bsubtilis_rRNA_db/" will be created in the current working directory.

3. Search the E. coli queries (200 nt-long, tiling the 16S rRNA) against the B. subtilis database using SHAPEwarp:

$ SHAPEwarp --output aln/ --query Queries/Ecoli_16S_invivo.txt --database Bsubtilis_rRNA_db/ --tblOut --reportAln f --makePlot -ow --matchKmerGCcontent --threads <n>

Take care to replace the argument of the --threads parameter with the number of processors on your machine.

4. Visualize the output:

$ ls -l aln/

drwxr-x---+ 2 danny danny  4096 Feb  7 14:34 alignments
drwxr-x---+ 2 danny danny  4096 Feb  7 14:34 images
-rw-r-----+ 1 danny danny   526 Feb  7 14:28 params.out
-rw-r-----+ 1 danny danny 11006 Feb  7 14:34 results.out

The file "paramters.out" stores the parameters used for the database search:

db=Bsubtilis_rRNA_db/
query=Queries/Ecoli_16S_invivo.txt
foldQuery=no
kmerLen=15
kmerOffset=1
minKmers=2
maxKmerDist=30
kmerMinComplexity=0.3
kmerMaxMatchEveryNt=200
matchKmerSeq=no
matchKmerGCcontent=yes
nullKmers=10000
alignMatchScore=-0.5,2
alignMismatchScore=-6,-0.5
alignGapOpenPenal=-14
alignGapExtPenal=-5
alignMaxDropOffRate=0.8
alignMaxDropOffBases=8
alignLenTolerance=0.1
alignScoreSeq=no
maxReactivity=1
maxAlignOverlap=0.5
evalAlignFold=no
inclusionEvalue=0.01
reportEvalue=1

The file "results.out" stores the results of the database search:

Query     DB    Qstart  Qend   Dstart  Dend   Qseed    Dseed      Score    P-value    E-value
16S_600   16S   0       199    608     807    60-114   668-722    190.53   4.47e-11   6.39e-09  !
16S_500   16S   0       196    508     704    160-186  668-694    203.47   2.30e-10   3.06e-08  !
16S_200   16S   9       199    216     406    120-183  327-390    187.13   3.13e-10   3.41e-08  !
16S_700   16S   0       161    708     869    65-129   773-837    159.63   3.19e-09   5.07e-07  !
16S_1300  16S   0       180    1308    1488   10-112   1318-1420  199.02   3.94e-09   6.19e-07  !
16S_900   16S   7       170    916     1079   16-100   925-1009   173.76   2.23e-08   1.16e-06  !
16S_400   16S   19      199    427     607    97-144   505-552    159.77   1.09e-07   1.42e-05  !
16S_300   16S   4       194    311     501    20-83    327-390    146.14   2.70e-07   3.40e-05  !
16S_800   16S   0       199    808     1008   73-199   882-1008   137.66   5.85e-07   6.67e-05  !
16S_last  16S   0       138    1350    1488   0-70     1350-1420  128.85   6.24e-07   7.30e-05  !
16S_1100  16S   49      199    1157    1307   68-96    1176-1204  132.35   9.51e-07   9.70e-05  !
16S_0     16S   10      161    17      168    85-102   92-109     87.73    6.57e-05   4.66e-03  !
16S_1200  16S   0       199    1208    1407   110-199  1318-1407  131.31   3.52e-05   5.39e-03  !
16S_1100  16S   40      194    55      209    170-185  185-200    80.03    4.52e-04   0.05      ?
16S_400   23S   25      155    1252    1382   74-92    1301-1319  87.09    3.55e-04   0.05      ?
16S_800   23S   47      164    1608    1725   64-81    1625-1642  80.20    4.64e-04   0.05      ?
16S_800   16S   46      161    30      145    56-71    40-55      76.82    6.86e-04   0.08      ?

Significant matches at the specified E-value threshold (0.01 by default) are marked with a !, while non-significant matches are marked with a ?. The "alignments/" and "images/" folders respectively contain the FASTA-formatted alignments of the matched RNA sequences and the SVG plots of the aligned SHAPE reactivity profiles.