Skip to content

Latest commit

 

History

History
28 lines (14 loc) · 2.07 KB

MAINTAINERS.md

File metadata and controls

28 lines (14 loc) · 2.07 KB

Specification maintainers

The bedRMod format is under development. We aim to integrate format specifications for RNA modification with the offical SAM/BAM and related specifications. This should encompass the ENCODE bedMethyl or the extended bedMethyl format proposed by Oxford Nanopre Technologies.

The development of the bedRMod format is supported by the Human RNome Project and currently financially enabled by the Transregio 319 RMaP. Current maintainers are listed below.

bedRMod

  • Etienne Boileau (@eboileau)

Updating the specifications

We aim to follow the same guidelines as SAM/BAM specification maintainers guidelines, consult this documentation for details.

Generating PDF specification documents

  1. Edit bedRModv1.8.tex, and type make new/bedRModv1.8.pdf to generate a working PDF to preview your work.

  2. When you are ready, commit your .tex source changes (but don't commit any changed PDF files yet).

  3. Type make clean bedRModv1.8.pdf to regenerate the PDF and copy it to the main directory. Optionally, verify that it contains the correct commit hash for your source changes. (Be sure to build the PDF using the commits on master; building the final PDF from a pull request is not recommended as its commits may be further rebased or otherwise amended before they appear on master, particularly if web UI merge buttons are used.)

  4. Commit your .pdf changes, separately from any source changes.

The Makefile can also generate PDFs highlighting the typeset differences between TeX source versions, invoked by typing make [OLD=commit [NEW=commit]] diff/SPEC.pdf. By default, this compares the working SPEC.tex file to the checked-out HEAD. Specify OLD to compare the working file to a different commit, or specify both OLD and NEW to show changes in SPEC between two commits.