millironx/nf-core_modules
1
0
Fork 0
mirror of https://github.com/MillironX/nf-core_modules.git synced 2024-12-22 11:08:17 +00:00
Code Issues Releases Packages Activity

Add note about other commands

Browse source
This commit is contained in:
drpatelh 2020-08-06 12:27:01 +01:00
parent 9142ad7016
commit d510854648
1 changed files with 57 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -1,6 +1,6 @@
# ![nf-core/modules](docs/images/nfcore-modules_logo.png)
> THIS REPOSITORY IS UNDER ACTIVE DEVELOPMENT. SYNTAX, ORGANISATION AND LAYOUT MAY CHANGE IN THE NEAR FUTURE!
> THIS REPOSITORY IS UNDER ACTIVE DEVELOPMENT. SYNTAX, ORGANISATION AND LAYOUT MAY CHANGE!
A repository for hosting Nextflow [`DSL2`](https://www.nextflow.io/docs/latest/dsl2.html) module files (see [Terminology](#terminology)) containing tool-specific process definitions and their associated documentation.
@ -18,10 +18,10 @@ A repository for hosting Nextflow [`DSL2`](https://www.nextflow.io/docs/latest/d
## Using existing modules
We have written a helper command in the nf-core/tools package that allows you to install any module present in the `software/` directory of this repository.
We have written a helper command in the `nf-core/tools` package that allows you to install any module present in the `software/` directory of this repository:
1. [Install](https://github.com/nf-core/tools#installation) the latest version of nf-core/tools (`>=1.10.2`)
2. List the available modules
1. [Install](https://github.com/nf-core/tools#installation) the latest version of `nf-core/tools` (`>=1.10.2`)
2. List the available modules:
```console
$ nf-core modules list
@ -48,6 +48,59 @@ We have written a helper command in the nf-core/tools package that allows you to
..truncated..
```
3. Install the module in the pipeline directory:
```console
$ nf-core modules install . fastqc
,--./,-.
___ __ __ __ ___ /,-._.--~\
|\ | |__ __ / ` / \ |__) |__ } {
| \| | \__, \__/ | \ |___ \`-._,-`-,
`._,._,'
nf-core/tools version 1.10.2
INFO Installing fastqc modules.py:62
INFO Downloaded 3 files to ./modules/nf-core/software/fastqc modules.py:97
```
We have plans to add other utility commands to help developers install and maintain modules downloaded from this repository.
```console
$ nf-core modules --help
,--./,-.
___ __ __ __ ___ /,-._.--~\
|\ | |__ __ / ` / \ |__) |__ } {
| \| | \__, \__/ | \ |___ \`-._,-`-,
`._,._,'
nf-core/tools version 1.10.2
Usage: nf-core modules [OPTIONS] COMMAND [ARGS]...
Work with the nf-core/modules software wrappers.
Tools to manage DSL 2 nf-core/modules software wrapper imports.
Options:
-r, --repository TEXT GitHub repository hosting software wrapper modules.
-b, --branch TEXT Modules GitHub repo git branch to use.
--help Show this message and exit.
Commands:
list List available software modules.
install Add a DSL2 software wrapper module to a pipeline.
update Update one or all software wrapper modules. (NOT YET IMPLEMENTED)
remove Remove a software wrapper from a pipeline. (NOT YET IMPLEMENTED)
check Check that imported module code has not been modified. (NOT YET IMPLEMENTED)
```
### Configuration and parameters
The module files hosted in this repository define a set of processes for software tools such as `fastqc`, `trimgalore`, `bwa` etc. This allows you to share and add common functionality across multiple pipelines in a modular fashion.