Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
GeVarLi
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TRANSVIHMI
nfernandez
GeVarLi
Commits
608baf16
Commit
608baf16
authored
1 year ago
by
nicolas.fernandez_ird.fr
Browse files
Options
Downloads
Patches
Plain Diff
docs: add download procedure help picture
parent
8a90e7d2
No related branches found
Branches containing commit
Tags
v.2023.06_1.1
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+15
-10
15 additions, 10 deletions
README.md
resources/visuals/download_button.png
+0
-0
0 additions, 0 deletions
resources/visuals/download_button.png
with
15 additions
and
10 deletions
README.md
+
15
−
10
View file @
608baf16
# GeVarLi: GEnome assembly, VARiant calling and LIneage assignation #
# GeVarLi: GEnome assembly
A
, VARiant calling and LIneage assignation #

 | Catalina (10.15.7) | Big Sure (11.6.3) | Monterey (12.6.0) | Ventura (13.3.1)/E6055C?icon=apple&label&list=|&scale=0.9
>
)
...
...
@@ -159,7 +159,7 @@ conda update -n base -c defaults conda
### GeVarLi ###
**Clone**
_to your home/_
[
GeVarLi
](
https://forge.ird.fr/transvihmi/nfernandez/GeVarLi
)
GitLab IRDForge repository _(ID: 399)_
_(128Mo)_
:
**Clone**
_to your home/_
[
GeVarLi
](
https://forge.ird.fr/transvihmi/nfernandez/GeVarLi
)
GitLab IRDForge repository _(ID: 399)_:
_(128 Mo required)_
```
shell
...
...
@@ -168,11 +168,17 @@ git clone --depth 1 https://forge.ird.fr/transvihmi/nfernandez/GeVarLi.git ~/GeV
**Update**
GeVarLi:
```
shell
cd
~/GeVarLi/
&&
git reset
--hard
HEAD
&&
git pull
--verbose
cd
~/GeVarLi/
&&
git reset
--hard
HEAD
&&
git pull
--depth
1
--verbose
```
Otherwise, you can
**download**
GeVarLi (no update through "git pull"):
Otherwise, you can
just
**download**
GeVarLi (no update through "git pull"):
_(75 Mo required)_

<img
src=
"./resources/visuals/download_button.png"
width=
"400"
height=
"100"
>
or
```
shell
curl https://forge.ird.fr/transvihmi/nfernandez/GeVarLi/-/archive/main/GeVarLi-main.tar.gz
-o
~/GeVarLi-main.tar.gz
&&
\
tar
-xzvf
~/GeVarLi-main.tar.gz
&&
\
...
...
@@ -185,7 +191,7 @@ rm -f ~/GeVarLi-main.tar.gz
1.
Copy your
**paired-end**
reads files, in
**.fastq.gz**
format, into:
**./resources/reads/**
directory
_Without reads, SARS-CoV-2 from ./resources/test\_data/ directory will be used_
2.
Execute
**Start_GeVarLi.sh**
bash script to run GeVarLi pipeline
_(according to your choice)_
:
2.
Execute
**Start_GeVarLi.sh**
bash script to run GeVarLi pipeline:
-
or with a
**Double-click**
on it _(if you make .sh files executable files with Terminal.app)_
-
or with a
**Right-click**
>
**Open with**
>
**Terminal.app**
-
or with
**CLI**
from a terminal:
...
...
@@ -198,7 +204,7 @@ _Option-1: Edit **config.yaml** file in **./configuration/** directory_
_Option-2: Edit **fastq-screen.conf** file in **./configuration/** directory_
First run will auto-created _(only once)_:
-
Workflow-Base
conda environment _(with: Snakemake, Mamba, Yq, Rename and GraphViz)_
-
Workflow-Baseconda environment _(with: Snakemake, Mamba, Yq, Rename and GraphViz)_
-
GeVarLi all tTools conda environments _(tools used by GeVarLi rules)_
-
Indexes for BWA and BOWTIE2 aligners _(for each fasta genomes in resources/ directory)_
...
...
@@ -285,9 +291,9 @@ _Some [temp] tagged files are removed by default, to save disk usage_
├── ⚙️ config.log
├── 📝 settings.log
├── 🍜 gevarli-base_v.
{
VERSION
}
.yaml
├── 🍜 gevarli-tools_v.
{
VERSION
}
.yaml
├── 📂 conda_env/
│ └── 📄
{
TOOLS
}
_v.
{
version
}
.yaml
├── 📂 files-summaries
│ └── 📄
{
PIPELINE
}
_files-summary.txt
├── 📂 graphs/
│ ├── 📈
{
PIPELINE
}
_dag.
{
PNG/PDF
}
│ ├── 📈
{
PIPELINE
}
_filegraph.
{
PNG/PDF
}
...
...
@@ -565,8 +571,7 @@ _F1000Research (2021)_
**Documentation**
:
[
https://snakemake.readthedocs.io/en/stable/index.html
](
https://snakemake.readthedocs.io/en/stable/index.html
)
**Anaconda Software Distribution**
Team
_Computer software (2016)_
_Team-Computer software (2016)_
**DOI**
:
[](
)
**Publication**
:
[
https://www.anaconda.com
](
https://www.anaconda.com
)
**Source code**
:
[
https://github.com/snakemake/snakemake
](
https://github.com/snakemake/snakemake
)
(
conda
)
...
...
This diff is collapsed.
Click to expand it.
resources/visuals/download_button.png
0 → 100644
+
0
−
0
View file @
608baf16
10.8 KiB
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment