Skip to content

Commit

Permalink
ADD docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eboileau committed Dec 16, 2024
1 parent 013493e commit c4ebbbd
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,16 @@ GNUmakefile
/diff/*.pdf
/diff/*.tex
/new/*.pdf

# documentation
.sass-cache/
/.jekyll-cache
/.jekyll-metadata
/_site
Gemfile
Gemfile.lock
.bundle/
vendor/

# local
/local
46 changes: 46 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: EU format specifications
email: [email protected]
description: >- # this means to ignore newlines until "baseurl:"
Epitranscriptome unified format (EUF) for bedRMod specifications.
baseurl: "/euf-specs" # the subpath of your site, e.g. /blog
url: "https://dieterich-lab.github.io" # the base hostname & protocol for your site, e.g. http://example.com
github_username: dieterich-lab

# Build settings
markdown: kramdown
theme: minima
plugins:
- jekyll-feed

exclude:
- Gemfile
- Gemfile.lock
- node_modules
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
- diff/
- new/
- scripts/
- tests/
- examples/
- README.md
- MAINTAINERS.md
- Makefile
- "*.tex"
7 changes: 7 additions & 0 deletions about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
layout: page
title: About
permalink: /about/
---

The bedRMod format originated in the [Transregio 319 RMaP](https://www.trr319-rmap.de) to support the [Human RNome Project](https://humanrnomeproject.org), and is used as the main data format in the [Sci-ModoM](https://scimodom.dieterichlab.org/) database.
20 changes: 20 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
# Feel free to add content and custom Front Matter to this file.
# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults

<!-- layout: home -->
layout: default
title: EU format specifications
---


The bedRMod format, similar to the [ENCODE bedMethyl](https://www.encodeproject.org/data-standards/wgbs) or the [extended bedMethyl](https://nanoporetech.github.io/modkit) format proposed by Oxford Nanopre Technologies, aims to formalize the representation of RNA modifications.

The bedRMod format is compatible with the BED (Browser Extensible Data) format, and most of the specifications are directly derived from the offical
BED specifications, available under the [SAM/BAM and related specifications](http://samtools.github.io/hts-specs).


Specifications:

- [bedRModv1.8](bedRModv1.8.pdf)

0 comments on commit c4ebbbd

Please sign in to comment.