Skip to content

Commit

Permalink
Enhance docker (#121)
Browse files Browse the repository at this point in the history
* start use docker script
* use pip script than src dir
* add local/Lifebit support compatibility
  • Loading branch information
liuyang2006 authored Oct 25, 2021
1 parent 7773f74 commit 0555898
Show file tree
Hide file tree
Showing 16 changed files with 106 additions and 108 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* Enables users to process **terabasescale** Oxford Nanopore sequencing datasets.
* Provide a one command line, **end-to-end pipeline** for analyzing Nanopore sequencing data for all methylation-calling tools.
* Support **various platform** executions: local, HPC and CloudOS, **without needs for tools' installation** (NANOME support docker and singularity).
* **First standardized whole genome-wide evaluation framework**, considering per-read and per-site performance for singletons/non-singletons, genic and intergenic regions, CpG islands/shores/shelves, differenct CG densities regions and repetitive regions.
* **First standardized whole genome-wide evaluation framework**, considering per-read and per-site performance for singletons/non-singletons, genic and intergenic regions, CpG islands/shores/shelves, different CG densities regions and repetitive regions.
* The **first Nextflow based DNA methylation-calling pipeline**. Please check more articles about Nextflow based workflow technology from Nature Biotechnology: https://doi.org/10.1038/s41587-020-0439-x and https://doi.org/10.1038/nbt.3820.

### CI/CD features
Expand Down
2 changes: 2 additions & 0 deletions conf/executors/lifebit.config
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ params{
input = 'https://github.com/TheJacksonLaboratory/nanome/raw/master/test_data/human_ci_test_fast5.tar.gz'
reference_genome = 'https://zenodo.org/record/5513090/files/hg38_chr22.tar.gz'

outputDir = 'results'

useDeepModCluster = false
moveOption = true
chrSet = true
Expand Down
15 changes: 8 additions & 7 deletions conf/executors/local.config
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
docker.enabled = true

params {
executor = 'local'
}

/*
* -------------------------------------------------
* Nextflow config for running on Local
* -------------------------------------------------
* Defines bundled configurations for process running
* on Local
*/
process {
container = params.docker_name
executor = 'local'
}
1 change: 1 addition & 0 deletions demo_google_cloud.sh
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ nextflow run main.nf\

echo "### nanome pipeline for demo data on google DONE"

exit 0
###########################################
###########################################
###########################################
Expand Down
5 changes: 3 additions & 2 deletions demo_hpc_winter.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ rm -rf ${workDir} ${outputsDir}
########################################
# Running pipeline for demo human data
# More options: -with-report -with-timeline -with-trace -resume -with-dag nanome_dag.png
# -config conf/executors/jaxhpc_input.config\
#
module load singularity
set -x
set -ex
nextflow run main.nf\
-profile singularity,hpc\
-config conf/executors/jaxhpc_input.config\
-work-dir ${workDir}\
--outputDir ${outputsDir}\
--dsname TestData\
Expand Down
6 changes: 0 additions & 6 deletions docs/Eval.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ The script `read_level_eval.py` is desinged for general purpose of read-level pe

```angular2html
read_level_eval.py -v
read_level_eval (NANOME) v1.3.7
```

## Sample usage
Expand Down Expand Up @@ -130,8 +128,6 @@ The script `site_level_eval.py` is desinged for general purpose of site-level pe

```angular2html
site_level_eval.py -v
site_level_eval (NANOME) v1.3.7
```


Expand Down Expand Up @@ -236,8 +232,6 @@ The script `tss_eval.py` is desinged for general purpose of converting raw resul

```angular2html
tss_eval.py -v
tss_eval (NANOME) v1.3.7
```

## Sample usage for read-level format unification
Expand Down
7 changes: 4 additions & 3 deletions ecoli_hpc_winter.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
#SBATCH --mem=20G # memory pool for all cores
#SBATCH --time=02:00:00 # time
#SBATCH --output=log/%x.%j.log # STDOUT & STDERR

#SBATCH [email protected]
#SBATCH --mail-type=END
date; hostname; pwd

# Base directory of running and output for nanome
Expand All @@ -26,12 +27,12 @@ rm -rf ${workDir} ${outputsDir}
########################################
# Running pipeline for E. coli data
module load singularity
set -x
set -ex
nextflow run main.nf\
-profile singularity,hpc\
-config conf/executors/jaxhpc_input.config,conf/examples/ecoli_demo.config\
-work-dir ${workDir}\
--outputDir ${outputsDir}\
-config conf/executors/jaxhpc_input.config,conf/examples/ecoli_demo.config\
--cleanCache false

# Report
Expand Down
Loading

0 comments on commit 0555898

Please sign in to comment.