{
  "@context": "https://w3id.org/ro/crate/1.1/context",
  "@graph": [
    {
      "@id": "ro-crate-metadata.json",
      "@type": "CreativeWork",
      "about": {
        "@id": "./"
      },
      "conformsTo": [
        {
          "@id": "https://w3id.org/ro/crate/1.1"
        },
        {
          "@id": "https://w3id.org/workflowhub/workflow-ro-crate/1.0"
        }
      ]
    },
    {
      "@id": "ro-crate-preview.html",
      "@type": "CreativeWork",
      "about": {
        "@id": "./"
      }
    },
    {
      "@id": "./",
      "@type": "Dataset",
      "mainEntity": {
        "@id": "main.nf"
      },
      "datePublished": "2025-03-06 17:04:20 +0000",
      "author": [
        {
          "@id": "https://orcid.org/0000-0003-2949-6719"
        },
        {
          "@id": "#creator-1"
        }
      ],
      "license": "MIT",
      "identifier": "https://workflowhub.eu/workflows/1320?version=1",
      "url": "https://workflowhub.eu/workflows/1320/ro_crate?version=1",
      "name": "Research Object Crate for sanger-tol/curationpretext",
      "description": "# ![sanger-tol/curationpretext](docs/images/curationpretext-light.png#gh-light-mode-only) ![sanger-tol/curationpretext](docs/images/curationpretext-dark.png#gh-dark-mode-only)\n\n[![GitHub Actions CI Status](https://github.com/sanger-tol/curationpretext/workflows/nf-core%20CI/badge.svg)](https://github.com/sanger-tol/curationpretext/actions?query=workflow%3A%22nf-core+CI%22)\n[![GitHub Actions Linting Status](https://github.com/sanger-tol/curationpretext/workflows/nf-core%20linting/badge.svg)](https://github.com/sanger-tol/curationpretext/actions?query=workflow%3A%22nf-core+linting%22)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.12773958-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.12773958)\n\n[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A524.04.0-23aa62.svg)](https://www.nextflow.io/)\n[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&amp;logo=docker)](https://www.docker.com/)\n[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)\n[![Launch on Nextflow Tower](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Nextflow%20Tower-%234256e7)](https://tower.nf/launch?pipeline=https://github.com/sanger-tol/curationpretext)\n\n## Introduction\n\n**sanger-tol/curationpretext** is a bioinformatics pipeline typically used in conjunction with [TreeVal](https://github.com/sanger-tol/treeval) to generate pretext maps (and optionally telomeric, gap, coverage, and repeat density plots which can be ingested into pretext) for the manual curation of high quality genomes.\n\nThis is intended as a supplementary pipeline for the [treeval](https://github.com/sanger-tol/treeval) project. This pipeline can be simply used to generate pretext maps, information on how to run this pipeline can be found in the [usage documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/usage).\n\n![Workflow Diagram](./assets/CurationPretext.png)\n\n1. Generate Maps - Generates pretext maps as well as a static image.\n\n2. Accessory files - Generates the repeat density, gap, telomere, and coverage tracks.\n\n## Usage\n\n&gt; **Note**\n&gt; If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how\n&gt; to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline)\n&gt; with `-profile test` before running the workflow on actual data.\n\nCurrently, the pipeline uses the following flags:\n\n- `--input`\n\n  - The absolute path to the assembled genome in, e.g., `/path/to/assembly.fa`\n\n- `--reads`\n\n  - The directory of the fasta files generated from longread reads, e.g., `/path/to/fasta/`\n\n- `--read_type`\n\n  - The type of longread data you are utilising, e.g., ont, illumina, hifi.\n\n- `--aligner`\n\n  - The aligner yopu wish to use for the coverage generation, defaults to bwamem2 but minimap2 is also supported.\n\n- `--cram`\n\n  - The directory of the cram _and_ cram.crai files, e.g., `/path/to/cram/`\n\n- `--map_order`\n\n  - hic map scaffold order, input either `length` or `unsorted`\n\n- `--teloseq`\n\n  - A telomeric sequence, e.g., `TTAGGG`\n\n- `-entry`\n  - ALL_FILES is the default and generates all accessory files as well as pretext maps\n  - MAPS_ONLY generates only the pretext maps and static images\n\nNow, you can run the pipeline using:\n\n#### For ALL_FILES run\n\n```bash\nnextflow run sanger-tol/curationpretext \\\n  --input { input.fasta } \\\n  --cram { path/to/cram/ } \\\n  --reads { path/to/longread/fasta/ } \\\n  --read_type { default is \"hifi\" }\n  --sample { default is \"pretext_rerun\" } \\\n  --teloseq { default is \"TTAGGG\" } \\\n  --map_order { default is \"unsorted\" } \\\n  --outdir { OUTDIR } \\\n  -profile \n\n```\n\n#### For MAPS_ONLY run\n\n```bash\nnextflow run sanger-tol/curationpretext \\\n  --input { input.fasta } \\\n  --cram { path/to/cram/ } \\\n  --reads { path/to/longread/fasta/ } \\\n  --read_type { default is \"hifi\" }\n  --sample { default is \"pretext_rerun\" } \\\n  --teloseq { default is \"TTAGGG\" } \\\n  --map_order { default is \"unsorted\" } \\\n  --outdir { OUTDIR } \\\n  -profile  \\\n  -entry MAPS_ONLY \\\n```\n\n&gt; **Warning:**\n&gt; Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those\n&gt; provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;\n\nFor more details, please refer to the [usage documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/usage) and the [parameter documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/parameters).\n\n## Pipeline output\n\nTo see the the results of a test run with a full size dataset refer to the [results](https://pipelines.tol.sanger.ac.uk/curationpretext/results) tab on the sanger-tol/curationpretext website pipeline page.\nFor more details about the output files and reports, please refer to the\n[output documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/output).\n\n## Credits\n\nsanger-tol/curationpretext was originally written by Damon-Lee B Pointon (@DLBPointon).\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n- @muffato - For reviews.\n\n- @yumisims - TreeVal and Software.\n\n- @weaglesBio - TreeVal and Software.\n\n- @josieparis - Help with better docs and testing.\n\n- @mahesh-panchal - Large support with 1.2.0 in making the pipeline more robust with other HPC environments.\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#curationpretext` channel](https://nfcore.slack.com/channels/curationpretext) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\nIf you use sanger-tol/curationpretext for your analysis, please cite it using the following doi: [10.5281/zenodo.12773958](https://doi.org/10.5281/zenodo.12773958)\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nYou can cite the `nf-core` publication as follows:\n\n&gt; **The nf-core framework for community-curated bioinformatics pipelines.**\n&gt;\n&gt; Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso &amp; Sven Nahnsen.\n&gt;\n&gt; _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n",
      "isBasedOn": "https://pipelines.tol.sanger.ac.uk/curationpretext",
      "sdDatePublished": "2026-04-22 02:57:26 +0100",
      "creativeWorkStatus": "Work-in-progress",
      "hasPart": [
        {
          "@id": "main.nf"
        }
      ]
    },
    {
      "@id": "main.nf",
      "@type": [
        "File",
        "SoftwareSourceCode",
        "ComputationalWorkflow"
      ],
      "contentSize": 2303,
      "programmingLanguage": {
        "@id": "#nextflow"
      },
      "dct:conformsTo": {
        "@id": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/"
      },
      "description": "# ![sanger-tol/curationpretext](docs/images/curationpretext-light.png#gh-light-mode-only) ![sanger-tol/curationpretext](docs/images/curationpretext-dark.png#gh-dark-mode-only)\n\n[![GitHub Actions CI Status](https://github.com/sanger-tol/curationpretext/workflows/nf-core%20CI/badge.svg)](https://github.com/sanger-tol/curationpretext/actions?query=workflow%3A%22nf-core+CI%22)\n[![GitHub Actions Linting Status](https://github.com/sanger-tol/curationpretext/workflows/nf-core%20linting/badge.svg)](https://github.com/sanger-tol/curationpretext/actions?query=workflow%3A%22nf-core+linting%22)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.12773958-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.12773958)\n\n[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A524.04.0-23aa62.svg)](https://www.nextflow.io/)\n[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&amp;logo=docker)](https://www.docker.com/)\n[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)\n[![Launch on Nextflow Tower](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Nextflow%20Tower-%234256e7)](https://tower.nf/launch?pipeline=https://github.com/sanger-tol/curationpretext)\n\n## Introduction\n\n**sanger-tol/curationpretext** is a bioinformatics pipeline typically used in conjunction with [TreeVal](https://github.com/sanger-tol/treeval) to generate pretext maps (and optionally telomeric, gap, coverage, and repeat density plots which can be ingested into pretext) for the manual curation of high quality genomes.\n\nThis is intended as a supplementary pipeline for the [treeval](https://github.com/sanger-tol/treeval) project. This pipeline can be simply used to generate pretext maps, information on how to run this pipeline can be found in the [usage documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/usage).\n\n![Workflow Diagram](./assets/CurationPretext.png)\n\n1. Generate Maps - Generates pretext maps as well as a static image.\n\n2. Accessory files - Generates the repeat density, gap, telomere, and coverage tracks.\n\n## Usage\n\n&gt; **Note**\n&gt; If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how\n&gt; to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline)\n&gt; with `-profile test` before running the workflow on actual data.\n\nCurrently, the pipeline uses the following flags:\n\n- `--input`\n\n  - The absolute path to the assembled genome in, e.g., `/path/to/assembly.fa`\n\n- `--reads`\n\n  - The directory of the fasta files generated from longread reads, e.g., `/path/to/fasta/`\n\n- `--read_type`\n\n  - The type of longread data you are utilising, e.g., ont, illumina, hifi.\n\n- `--aligner`\n\n  - The aligner yopu wish to use for the coverage generation, defaults to bwamem2 but minimap2 is also supported.\n\n- `--cram`\n\n  - The directory of the cram _and_ cram.crai files, e.g., `/path/to/cram/`\n\n- `--map_order`\n\n  - hic map scaffold order, input either `length` or `unsorted`\n\n- `--teloseq`\n\n  - A telomeric sequence, e.g., `TTAGGG`\n\n- `-entry`\n  - ALL_FILES is the default and generates all accessory files as well as pretext maps\n  - MAPS_ONLY generates only the pretext maps and static images\n\nNow, you can run the pipeline using:\n\n#### For ALL_FILES run\n\n```bash\nnextflow run sanger-tol/curationpretext \\\n  --input { input.fasta } \\\n  --cram { path/to/cram/ } \\\n  --reads { path/to/longread/fasta/ } \\\n  --read_type { default is \"hifi\" }\n  --sample { default is \"pretext_rerun\" } \\\n  --teloseq { default is \"TTAGGG\" } \\\n  --map_order { default is \"unsorted\" } \\\n  --outdir { OUTDIR } \\\n  -profile \n\n```\n\n#### For MAPS_ONLY run\n\n```bash\nnextflow run sanger-tol/curationpretext \\\n  --input { input.fasta } \\\n  --cram { path/to/cram/ } \\\n  --reads { path/to/longread/fasta/ } \\\n  --read_type { default is \"hifi\" }\n  --sample { default is \"pretext_rerun\" } \\\n  --teloseq { default is \"TTAGGG\" } \\\n  --map_order { default is \"unsorted\" } \\\n  --outdir { OUTDIR } \\\n  -profile  \\\n  -entry MAPS_ONLY \\\n```\n\n&gt; **Warning:**\n&gt; Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those\n&gt; provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;\n\nFor more details, please refer to the [usage documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/usage) and the [parameter documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/parameters).\n\n## Pipeline output\n\nTo see the the results of a test run with a full size dataset refer to the [results](https://pipelines.tol.sanger.ac.uk/curationpretext/results) tab on the sanger-tol/curationpretext website pipeline page.\nFor more details about the output files and reports, please refer to the\n[output documentation](https://pipelines.tol.sanger.ac.uk/curationpretext/output).\n\n## Credits\n\nsanger-tol/curationpretext was originally written by Damon-Lee B Pointon (@DLBPointon).\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n- @muffato - For reviews.\n\n- @yumisims - TreeVal and Software.\n\n- @weaglesBio - TreeVal and Software.\n\n- @josieparis - Help with better docs and testing.\n\n- @mahesh-panchal - Large support with 1.2.0 in making the pipeline more robust with other HPC environments.\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#curationpretext` channel](https://nfcore.slack.com/channels/curationpretext) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\nIf you use sanger-tol/curationpretext for your analysis, please cite it using the following doi: [10.5281/zenodo.12773958](https://doi.org/10.5281/zenodo.12773958)\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nYou can cite the `nf-core` publication as follows:\n\n&gt; **The nf-core framework for community-curated bioinformatics pipelines.**\n&gt;\n&gt; Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso &amp; Sven Nahnsen.\n&gt;\n&gt; _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n",
      "name": "sanger-tol/curationpretext",
      "url": "https://workflowhub.eu/workflows/1320?version=1",
      "keywords": "Bioinformatics, Genomics",
      "version": 1,
      "license": "https://spdx.org/licenses/MIT",
      "creator": [
        {
          "@id": "https://workflowhub.eu/people/604"
        },
        {
          "@id": "#Mahesh%20Panchel"
        }
      ],
      "producer": [
        {
          "@id": "https://workflowhub.eu/projects/204"
        },
        {
          "@id": "https://workflowhub.eu/projects/205"
        }
      ],
      "dateCreated": "2025-03-12T10:19:06Z",
      "dateModified": "2025-03-12T10:19:06Z",
      "isPartOf": [

      ],
      "input": [

      ],
      "output": [

      ],
      "sdPublisher": {
        "@id": "https://about.workflowhub.eu/"
      }
    },
    {
      "@id": "https://orcid.org/0000-0003-2949-6719",
      "@type": "Person",
      "name": "Damon-Lee Pointon",
      "identifier": "https://orcid.org/0000-0003-2949-6719"
    },
    {
      "@id": "#creator-1",
      "@type": "Person",
      "name": "Mahesh Panchel"
    },
    {
      "@id": "https://workflowhub.eu/people/604",
      "@type": "Person",
      "name": "Damon-Lee Pointon"
    },
    {
      "@id": "#Mahesh Panchel",
      "@type": "Person",
      "name": "Mahesh Panchel"
    },
    {
      "@id": "https://workflowhub.eu/projects/204",
      "@type": [
        "Project",
        "Organization"
      ],
      "name": "Tree of Life Genome Assembly"
    },
    {
      "@id": "https://workflowhub.eu/projects/205",
      "@type": [
        "Project",
        "Organization"
      ],
      "name": "Tree of Life Genome Analysis"
    },
    {
      "@id": "#nextflow",
      "@type": "ComputerLanguage",
      "name": "Nextflow",
      "identifier": {
        "@id": "https://www.nextflow.io/"
      },
      "url": {
        "@id": "https://www.nextflow.io/"
      }
    },
    {
      "@id": "https://about.workflowhub.eu/",
      "@type": "Organization",
      "name": "WorkflowHub",
      "url": "https://about.workflowhub.eu/"
    }
  ]
}