diff --git a/client/src/components/home/HomeFeatures.vue b/client/src/components/home/HomeFeatures.vue index ac430b96..d065f430 100644 --- a/client/src/components/home/HomeFeatures.vue +++ b/client/src/components/home/HomeFeatures.vue @@ -14,7 +14,15 @@
- Sci-ModoM is under active development. Consult our roadmap for 2024
-
-
Query nomenclature @@ -30,25 +29,22 @@ import SubTitle from '@/components/ui/SubTitle.vue'
Sci-ModoM allows to query RNA modification sites according to RNA type, species, technology, and genomic features (Search). The classification - of detection technologies is based on - Detection technologies for RNA modifications. + of detection technologies is based on the underlying assay, + e.g. + antibody-based, chemically- or enzymatically-treated, or direct read-out (Nanopore).
Project and dataset
Data is also accessible at the study- or dataset-level (Browse). Each dataset is assigned a EUFID or - EUF identifier. One or more dataset can belong to a - study or project, e.g. dataset "Wildtype HEK293T" and - "Wildtype mESC" belong to the "GLORI" project. Projects are identified using a - SMID or + >). One or more dataset can belong to a study or project, + e.g. dataset "Wildtype HEK293T" and "Wildtype mESC" belong to + the "GLORI" project. Each dataset is assigned a + EUFID or + Epitranscriptome Unified exchange Format (EUF) identifier. Projects are identified using a SMID or Sci-ModoM identifier. A dataset can include one or more modification, but is uniquely associated with a given species (including cell type, tissue, or organ) and technology. @@ -58,7 +54,8 @@ import SubTitle from '@/components/ui/SubTitle.vue'
Simply put, a dataset consists of per-site records of RNA modifications stored in a given
- bedRMod file. For more information, consult the
+ bedRMod file. This file contains a formatted header with metadata, followed by distinct
+ RNA modification sites, one per line. For more information, consult the
- Available assemblies for different organisms define the assembly version used in
- Sci-ModoM. Dataset that do not match the database assembly version are lifted over. Only
- chromosomes are considered.
+ Only one genome assembly version per species is used in Sci-ModoM. Dataset that do not
+ match the database assembly version are lifted over. Only chromosome-level information is
+ considered; unassigned contigs or scaffolds are discarded.
Annotation
- Annotation are created by intersecting dataset records with features (UTRs, CDS, ...)
- merged across transcripts extracted from a given Ensembl GTF file.
+ Datasets are annotated with gene informations and genomic features (UTRs, CDS, ...) using
+ a fixed version of Ensembl.
For detailed documentation and development notes, consult the
@@ -92,6 +89,13 @@ import SubTitle from '@/components/ui/SubTitle.vue'
>server documentation
+ Consult our development plan for 2024
+
- To query the database for RNA modifications, first select a modification and species, then - available technologies. Sci-ModoM contains a large amount of records; selecting a - particular gene or genomic region can significantly reduce the query time. The search can - also be narrowed down by selecting a biotype or a genomic feature. Selected records can be - exported to CSV. To download all records for a given dataset, use + Search modifications site-wise across whole transcriptomes. To query the database, first + select a modification and species, then available technologies. Some dataset may contain a + large amount of records; selecting a particular gene of interest or a genomic region can + significantly reduce the query time. The search can also be narrowed down by selecting a + biotype or a genomic feature. Selected records can be exported to CSV. To download all + records for a given dataset, use Browse.
@@ -115,22 +120,31 @@ import SubTitle from '@/components/ui/SubTitle.vue' Browse
- Query the database to find projects, studies and/or dataset. You can refine your search - using global filters (top left of table), or table filters (RNA type and modification, - organism, cell, tissue and/or organ, or technology). Click the + Query the database to find projects and/or datasets. You can refine your search using + global filters (top left of table), or table filters (RNA type and modification, organism, + cell, tissue and/or organ, or technology). Click the button to see project-related information and - additional attachments. A dataset can be downloaded as a bedRMod file. Records can be - exported to CSV. + additional attachments. A dataset can be downloaded as a + bedRMod + file. The list of datasets and their metadata can be exported to CSV.
- Compare dataset by finding modification sites common to multiple dataset (intersection) or - those only found in a group of dataset (difference). You can also find modification sites - in a given dataset that are close to, but not intersecting with sites in other dataset - (closest). You can perform these operations using available dataset, but you can also - compare dataset with your own data. + Compare datasets site-wise, including your own, without registration or login. You can + compare datasets to one another by finding modification sites common to multiple datasets + (intersection) or those only found in a group of datasets (difference). You can also find + modification sites in a given dataset that are close to, but not intersecting with sites + in other datasets (closest). You can perform these operations strand-aware or unaware. You + can use available datasets, or upload your own data to compare it against database + records. You data is securely handled and is automatically deleted afterwards.
1. First select a given organism, then select up to 3 @@ -162,7 +176,7 @@ import SubTitle from '@/components/ui/SubTitle.vue' Sci-ModoM is freely available, and does not require login or registration. Interested users can however register to propose new projects, and eventually upload - dataset and attachments that are made publicly available to all users. + datasets and attachments that are made publicly available to all users.
Project template @@ -205,6 +219,17 @@ import SubTitle from '@/components/ui/SubTitle.vue' Use the Attach BAM files form to upload attachments. Attaching BAM files to a given dataset allow users to access read-level information.
++ bedRMod + uses a 0-based, half-open coordinate system. If you use a 1-based index, all your + modification sites will be off-by-one! +
Dataset upload errors
diff --git a/server/docs/source/bedrmod.rst b/server/docs/source/bedrmod.rst index bd1f9a97..67599d7e 100644 --- a/server/docs/source/bedrmod.rst +++ b/server/docs/source/bedrmod.rst @@ -98,6 +98,11 @@ The data section The first nine columns generally follow the standard `BED specification