Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 

Repository files navigation

cat < README.md

🧬 Nextflow Project Template Generator

This repository contains a universal automation script to initialize a standardized, nf-core aligned folder structure for bioinformatics pipelines (specifically optimized for Single-Cell Analysis).

πŸš€ One-Line Usage

Open your terminal and run this command from anywhere to create a new project. Replace `path/to/project` with your desired location:

```bash curl -s https://raw.githubusercontent.com/MJBioInfo/nf-templates/main/folder_creation.sh | bash -s -- path/to/project ```

πŸ“‚ Included Structure

The script automatically generates:

  • workflows/: Main pipeline logic (`main.nf`).
  • conf/data_params/: Dedicated space for your `dataset.yaml` files.
  • data/: Folders for raw and reference data (ignored by Git).
  • results/: Organized output structure for Seurat/AnnData objects.
  • Configs: Pre-configured `.gitignore` and `nextflow.config`.

πŸ› οΈ Workflow Steps

  1. Initialize: Run the curl command above.
  2. Configure: Edit `conf/data_params/dataset_v1.yaml` with your data paths.
  3. Execute: ```bash nextflow run workflows/main.nf -params-file conf/data_params/dataset_v1.yaml ```

Status Badges: Portable Automation Single-Cell EOF

About

This is the Template for Nextflow project folder creation on any machine running from any terminal

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages