index.md

nft-utils

nft-utils is an nf-test plugin to provide additional functions and assertions that fall outside of the typical nf-test features. They were primarily developed by the nf-core community but should be applicable to any nf-tests.

Start using the plugin

To start using the plugin please add it to your nf-test.config file:

config {
    plugins {
        load "[email protected]"
    }
}

Have a look at the usage documentation for more information on how to start working with the plugin.

Use a development version

To use the development version, please do the following steps:

• Clone the nft-utils repository

=== "HTTPS"

```bash
git clone [email protected]:nf-core/nft-utils.git
```

=== "SSH"

```bash
git clone https://github.com/nf-core/nft-utils.git
```

• Run the build script

./build.sh

• Add the jar location (visible at the end of the build script output) to the nf-test.config file

config {
    plugins {
        loadFromFile "full/path/to/the/plugin/jar"
    }
}