Forrest logo
back to the nf-core tool

nf-core:tldr:da0a8

nf-core: Create a new pipeline skeleton.
$ nf-core create
try on your machine

The command "nf-core create" is a command-line command used to create a new pipeline project using the nf-core framework. nf-core is a collection of community-curated and standardized bioinformatics pipelines built using Nextflow, a workflow management system.

When you run the "nf-core create" command, it prompts you to provide essential details about your pipeline project, such as the pipeline name, its description, and the license you want to use. Once you provide this information, the command creates a new folder with the specified pipeline name, populated with the required files and directory structure.

Here's an example of how to use the "nf-core create" command:

nf-core create my_pipeline

After executing this command, it will create a new folder named "my_pipeline" with the necessary files and directories needed to begin developing your pipeline. Inside the folder, you will find important files like the main pipeline script (main.nf), a "tests" directory for automated testing, a "docs" directory for documentation, a "configs" directory for different configuration options, and other essential files needed for running and maintaining your pipeline.

By running "nf-core create", it helps bootstrap your pipeline project by providing a standard structure and essential components, ensuring consistency across nf-core pipelines and simplifying the development process.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the nf-core tool