Skip to content
Snippets Groups Projects
Commit e7483a62 authored by Hugo V's avatar Hugo V
Browse files

Issue #145. Added page template and reviewer guide

parent b297681c
No related branches found
No related tags found
1 merge request!27Issue #145. Added page template and reviewer guide
Pipeline #114763 passed
title: <!--Replace this with Defense system name-->
tableColumns:
article:
doi: <!--Replace this with the main article doi-->
abstract:
<!--Replace this with the abstract of the main article-->
Sensor: '<!--Fill sensor name here. If it's unknown : Leave it blank -->'
Activator: ' <!--Fill activator name here. If it's unknown : Leave it blank -->'
Effector: '<!--Fill effector name here. If it's unknown : Leave it blank -->'
PFAM: <!--PFXXXXX, PFYYYYY, PFZZZZZ-->
<!--Markdown syntax in a nutshell-->
<!--Move it to a dedicated file ?-->
<!--Use # for titles : # Main title ; ## Secondary title ; ### Tertiary title ; etc.-->
<!--Use * * for italic : *this text will be displayed in italic*-->
<!--Use ** ** for bold text : **this text will be displayed in bold**-->
<!--Use []() for links to external websites : ![This text will be displayed, if you click on it you will be directed to the website](https://url.of.the.website)-->
<!--Use ![alt text](path.to.image "Image title") to embed an image. Do we have an 'images' directory in the repo ?-->
<!--That's all folks!-->
# Defense system name
<!--Replace the main title with the name of the defense system
Example : # CBASS
-->
## Description
<!--This paragraph contains a short description of the defense system. It should provide the essential information regarding the system at a glance.
- How many proteins compose the defense system ? What are their name and what is their biological function ?
- Optionally, you can quickly state in which model organism the system was tested and against which phages.
Please don't forget to refer to the articles that you will cite at the end of the article.
This should be precise but as synthetic as possible (rule of thumb : a dozen of lines maximum).
Example :
"RADAR is comprised of two genes, encoding respectively for an adenosine triphosphatase (RdrA) and a divergent adenosine deaminase (RdrB) [1], which are in some cases associated with a small membrane protein (RdrC or D) [1].
RADAR was found to perform RNA editing of adenosine to inosine during phage infection. Editing sites are broadly distributed on the host transcriptome, which could prove deleterious to the host and explain the observed growth arrest of RADAR upon phage infection."
-->
## Molecular mechanism
<!--If the mechanism of action of the defense system is known, please describe it in one short paragraph. If the exact mechanism is not known, simply state it and sum up the information available in the literature.
This should be precise but as synthetic as possible (rule of thumb : a dozen of lines maximum).
Example :
The exact mechanism of action of the Shango defense system has not yet been characterized, but it was shown that the TerB domain and the catalytic activity of the ATPase and the Helicase are required to provide antiviral defense. The fact that TerB domains are known to be associated to the periplasmic membrane could indicate that Shango might be involved in membrane surveillance [1].
-->
## Example of genomic structure
<!--Automatically filled.
You can optionally describe in more details which proteins compose the system if the Description paragraph did give all the information-->
## Distribution of the system among prokaryotes
<!--Automatically filled-->
## Structure
<!--Automatically filled-->
## Experimental validation
<!--Give more information about the experimental validation :
- In which organism was it tested ?
- Against which phages ?
Please do not forget to cite the papers which provide the information.
-->
## Relevant abstracts
::article-doi-list
---
items:
- doi: <!--replace this with the doi of a relevant abstract-->
- doi: <!--replace this with the doi of a second relevant abstract-->
---
::
## References
<!--Provide here the references mentioned in the wiki page :
- Citation in APA style + optionally the DOI in the following format : [doi](doi).
Example :
- Millman, A., Melamed, S., Leavitt, A., Doron, S., Bernheim, A., Hör, J., ... & Sorek, R. (2022). An expanded arsenal of immune systems that protect bacteria from phages. Cell host & microbe, 30(11), 1556-1569. [https://doi.org/10.1016/j.chom.2022.09.017](https://doi.org/10.1016/j.chom.2022.09.017)
-->
This is a guide to help you review an article of the wiki. Please check that all the following criteria are met to consider that a page is complete and correct.
[ ] The article is correctly structured.
It should contain :
1. Header with the following fields (please pay attention to block indentation)
---
title:
tableColumns:
article:
doi:
abstract:
Sensor:
Activator:
Effector:
PFAM:
---
2. The following paragraphs
- Description
- Molecular mechanisms
- Example of genomic structure
- Distribution of the system among prokaryotes
- Structure
- Experimental validation
- Relevant abstracts with the following structure
::article-doi-list
---
items:
- doi:
---
::
- References
[ ] The header contains all the required information.
The information provided in the header is required to display the list of defense systems. The mandatory fields are : ```title:```, ```article```, ```doi```, ```abstract``` and ```PFAM```. Optional fields are ```Sensor```, ```Activator``` and ```Effector```.
[ ] Main title is correct.
For a defense system, it should simply be the name of the system.
[ ] All the information is provided, correct and understandable.
Rule of thumb : As a newcommer in the field, does the page provide the essential information in a clear way regarding the system ?
[ ] Short description of the system
[ ] Composition of the system
[ ] Mechanism of action if it is known
[ ] References to the literature to further explore the defense system
[ ] Links with the database are working.
[ ] Distribution of the system among prokaryotes
[ ] Structure display
[ ] At least one relevant abstract is provided.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment