Creating and updating templates
Adding new templates
If you would like to submit a new template or replace an existing one, please submit an issue on GitHub including:
A FASTA or BPSEQ file with a reference sequence and secondary structure - see FASTA and BPSEQ examples
A Traveler XML file - see example
Description of the new template and any relevant background information
:warning: GitHub currently does not support attaching files with .fasta
or .bpseq
extensions so please attach the files as .txt
.
We will review the template and reply on GitHub as soon as possible.
Manually creating templates
Creating templates using FASTA/BPSEQ and Traveler XML files
Place new FASTA or BPSEQ file(s) in the
data/new
folderRun
r2dt.py generatecm
. The command will generate new.cm
file(s) with the covariance modelsMove the new
.cm
and.tr
files in the destination directory (for example,ribovision-ssu
is where all SSU templates submitted by the RiboVision group are stored)Run
r2dt.py generatemodelinfo <destination>/cms
to add new models to the list of searched models where<destination>
is the same folder as in the step aboveUpdate
metadata.tsv
file in the destination directoryRun
r2dt.py list-models
to update a list of all available modelsVerify that the templates work as expected by testing on a fasta file with a sequence similar to the template
Run tests and update the model counts in
TestCovarianceModelDatabase
as needed
Creating templates using RNA 2D JSON Schema files
It is possible to generate new templates using RNA 2D JSON Schema files as input.
Generate a structure using R2DT on the command line and locate the JSON output file
Upload JSON file to an interactive editor
Manually edit the layout
Download the edited structure as a new JSON file and save it in the
data/new
folderRun the following command:
r2dt.py generate-template data/new/<input.json>
The new Traveler template, covariance model, and a fasta file will be generated in the
data/new
folder.
Other ways of creating templates
One can also create new templates locally using the generate_cm_library.py script with the FASTA and XML files described above.
It is also possible to generate a new template using a special version of the XRNA software, XRNA-GT.
Updating Rfam templates
The following procedure should be done after each Rfam release:
Recompute all Rfam templates (takes ~6h)
r2dt.py setup-rfam
Run tests
Generate new precomputed library archive
tar -czvf cms.tar.gz <path/to/new/cms>
The folder should contain 2 subfolders:
crw
andrfam
.Update the precomputed library link in Readme
Update a list of available models
r2dt.py list-models
⚠️ Note that the tRNA Rfam Traveler template has been manually edited to match the standard tRNA layout so the automatically generated
traveler-template.xml
file should be discarded and the current version should be kept.