Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

data-intuitive/nf-plugin-template

Open more actions menu
 
 

Repository files navigation

nf-plugin-template plugin

Creating your plugin

The Nextflow plugin template is a scaffold for plugin development. The simplest way to create a new plugin is to use the nextflow plugin create sub-command to create a plugin project based on the template.

Create a new plugin with the following command:

nextflow plugin create

See Creating a plugin for more information.

Building

To build the plugin:

make assemble

Testing with Nextflow

The plugin can be tested without a local Nextflow installation:

  1. Build and install the plugin to your local Nextflow installation: make install
  2. Run a pipeline with the plugin: nextflow run hello -plugins nf-plugin-template@0.1.0

Publishing

Plugins can be published to a central plugin registry to make them accessible to the Nextflow community.

Follow these steps to publish the plugin to the Nextflow Plugin Registry:

  1. Create a file named $HOME/.gradle/gradle.properties, where $HOME is your home directory. Add the following properties:
    • npr.apiKey: Your Nextflow Plugin Registry access token.
  2. Use the following command to package and create a release for your plugin on GitHub: make release.

Note

The Nextflow Plugin registry is currently available as preview technology. Contact info@nextflow.io to learn how to get access to it.

About

Template project for creating Nextflow plugins (beta)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Groovy 90.3%
  • Makefile 5.9%
  • Nextflow 3.8%
Morty Proxy This is a proxified and sanitized view of the page, visit original site.