Skip to content
Snippets Groups Projects
Commit cfa99c8d authored by aucomte's avatar aucomte
Browse files

update doc

parent b8317407
No related branches found
No related tags found
No related merge requests found
......@@ -14,7 +14,7 @@ To create file juste run
RNAja create_config --help
RNAja create_config -configyaml Path/to/file
Then edit section on file according to your workflow.
Then edit section on file according to your data.
First, indicate the data path in the configuration ``config.yaml`` file:
......@@ -28,6 +28,33 @@ First, indicate the data path in the configuration ``config.yaml`` file:
'annotation': "DATA/ref/msu7.gtf"
'sample_info': "DATA/sample_info.txt"
.. csv-table::
"Input", "Description"
"out_dir", "path / name of the output directory"
"reference", "Only one REFERENCE genome file (fasta file)"
"annotation", "Annotation file corresponding to the reference file (gtf or gff)"
"sample_info", "path of the file containing information on the sample and the experimental design (csv or txt, separator = ',')"
exemple of sample_info file:
.. csv-table::
"FileName", "SampleName", "Condition1", "Condition2"
"/path/to/fastq/Control1", "C_1", "Control", "E1"
"/path/to/fastq/Control2", "C_2", "Control", "E2"
"/path/to/fastq/Control3", "C_3", "Control", "E3"
"/path/to/fastq/Treatment1", "T_1", "Treat", "E1"
"/path/to/fastq/Treatment2", "T_2", "Treat", "E2"
"/path/to/fastq/Treatment3", "T_3", "Treat", "E3"
.. warning::
For the column SampleName of the sampleInfo file, the names should be: condition_repetition separated by a _
.. ############################################################
How to run the workflow
......
......@@ -50,6 +50,7 @@ def main():
include_package_data=True,
python_requires='>=3.6',
install_requires=[
'pandas',
'cookiecutter',
'snakemake',
'tqdm',
......
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