Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
340f3b2
polish contributions.md
ochkalova Jul 8, 2026
9692ab3
add limitations block
ochkalova Jul 8, 2026
4452cb8
refactor limitations block
ochkalova Jul 8, 2026
6bda9c7
add scalability section to README.md
ochkalova Jul 8, 2026
9074e16
refactor contributing guidelines
ochkalova Jul 8, 2026
fe61978
start changing
KateSakharova Jul 9, 2026
3e9998f
fix
KateSakharova Jul 9, 2026
44c38d9
update CONTRIBUTING.md to clarify testing requirements for ENA submis…
ochkalova Jul 9, 2026
67d436a
add some links
KateSakharova Jul 9, 2026
b0343f4
update README.md to reference Methods documentation for metadata stat…
ochkalova Jul 9, 2026
f7f99b3
refactor methods documentation to clarify RNA presence detection and …
ochkalova Jul 9, 2026
36567f4
add SVG pipeline metromap
ochkalova Jul 9, 2026
c57e865
update README.md Limitations to include issue tracking
ochkalova Jul 10, 2026
f759e9c
update README.md to add a Table of Contents
ochkalova Jul 10, 2026
a7f6dd6
Move Data privacy section to usage.md
ochkalova Jul 10, 2026
81e64bd
use one format for tables with column descriptions in usage.md
ochkalova Jul 10, 2026
c11bab2
more fixes
KateSakharova Jul 10, 2026
6aea0f8
slim Samplesheet descriptions in README to minimum
ochkalova Jul 10, 2026
9394073
Add Table of Contents to usage.md
ochkalova Jul 10, 2026
cd8d99a
move Submission Study section up in usage.md
ochkalova Jul 10, 2026
ae6b462
Expand Requirements to include required pre-submissions
ochkalova Jul 10, 2026
bea141a
Apply James' suggesstions in usage.md
ochkalova Jul 10, 2026
59c7746
restructure usage.md
ochkalova Jul 15, 2026
b61853e
polish usage.md structure and wording
ochkalova Jul 17, 2026
6d38ce3
update pipeline metromap
ochkalova Jul 17, 2026
2db92bd
restructure README
ochkalova Jul 17, 2026
018d328
Add section for Third Party Assemblies (TPA) in usage.md
ochkalova Jul 17, 2026
38b208d
Merge pull request #83 from nf-core/doc/limitations-scalability
KateSakharova Jul 20, 2026
5a35079
Merge branch '1.0.0' into fix/docs-review
KateSakharova Jul 21, 2026
36700b4
many fixes
KateSakharova Jul 21, 2026
1a31a0f
rename sample to id in samplesheet and add fields to meta directly fr…
KateSakharova Jul 21, 2026
f1228e7
Fix prettier issues with docs/usage.md
mberacochea Jul 22, 2026
0a6e44b
tidy up .map after review
KateSakharova Jul 22, 2026
5b262bf
add null values as defaults for conditional args
KateSakharova Jul 22, 2026
54acdc9
update genome_uploader and fix regexp in multiqc
KateSakharova Jul 22, 2026
648ca9e
test multiqc config old version from 1.0.0 branch
KateSakharova Jul 22, 2026
edd594a
change co-assembly and rna_presence to boolean
KateSakharova Jul 22, 2026
d3d61ad
Template update for nf-core/tools version 4.0.3
nf-core-bot Jul 24, 2026
d0e42be
change limits for coverage, completeness and contamination
KateSakharova Jul 27, 2026
774f69c
Apply suggestion from @ochkalova
KateSakharova Jul 27, 2026
99970b6
Update subworkflows/local/genome_evaluation/main.nf
KateSakharova Jul 27, 2026
1a322b6
Update conf/test_assembly_complete_metadata.config
KateSakharova Jul 27, 2026
fb2db68
Merge pull request #88 from nf-core/fix/meta_objects
KateSakharova Jul 27, 2026
2a0364c
remove nr from main workflow and add to taxonomy subwf
KateSakharova Jul 27, 2026
8af5f50
Update docs and schemas for better descriptions
KateSakharova Jul 27, 2026
645df17
Merge pull request #86 from nf-core/fix/docs-review
KateSakharova Jul 27, 2026
b4a5d48
aligned docs and schemas
KateSakharova Jul 28, 2026
68a9c22
docs polishing
KateSakharova Jul 30, 2026
4f98fff
Merge pull request #93 from nf-core/fix/unify-schema-and-docs
KateSakharova Jul 30, 2026
3a74926
Merge branch '1.0.0' into nf-core-template-merge-4.0.3
KateSakharova Jul 30, 2026
19067fb
remove files_unchanged
KateSakharova Jul 30, 2026
decd115
revert files_unchanged
KateSakharova Jul 30, 2026
5673e5b
Merge pull request #90 from nf-core/nf-core-template-merge-4.0.3
KateSakharova Jul 30, 2026
fb3c3f1
Merge branch 'dev' into 1.0.0
KateSakharova Jul 30, 2026
670bdc6
Revise resource settings guidance in usage documentation
KateSakharova Jul 30, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ These are the most common things requested on pull requests (PRs).

Remember that PRs should be made against the dev branch, unless you're preparing a pipeline release.

Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/seqsubmit/tree/master/docs/CONTRIBUTING.md)
Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/seqsubmit/tree/main/docs/CONTRIBUTING.md)
-->

## PR checklist

- [ ] This comment contains a description of changes (with reason).
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/seqsubmit/tree/master/docs/CONTRIBUTING.md)
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/seqsubmit/tree/main/docs/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/seqsubmit _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core pipelines lint`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/nf-test/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ runs:

- name: Setup apptainer
if: contains(inputs.profile, 'singularity')
uses: eWaterCycle/setup-apptainer@3f706d898c9db585b1d741b4692e66755f3a1b40 # v2
uses: eWaterCycle/setup-apptainer@4bb22c52d4f63406c49e94c804632975787312b3 # v2.0.0

- name: Set up Singularity
if: contains(inputs.profile, 'singularity')
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-announcements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
id: get_description
run: |
echo "description=$(curl -s https://nf-co.re/pipelines.json | jq -r '.remote_workflows[] | select(.full_name == "${{ github.repository }}") | .description')" >> $GITHUB_OUTPUT
- uses: rzr/fediverse-action@563159eb8d45f70ab6aaba36ed55cd037e51f441 # master
- uses: rzr/fediverse-action@66c2cbb5b1997666b0e28d597631b6a4f09a2719 # v0.0.6
with:
access-token: ${{ secrets.MASTODON_ACCESS_TOKEN }}
host: "mstdn.science" # custom host if not "mastodon.social" (default)
Expand Down
7 changes: 3 additions & 4 deletions .nf-core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@ lint:
- docs/images/nf-core-seqsubmit_logo_light.png
- docs/images/nf-core-seqsubmit_logo_dark.png
- assets/nf-core-seqsubmit_logo_light.png
- .github/workflows/branch.yml
- .github/workflows/linting.yml
nf_core_version: 4.0.2
nf_core_version: 4.0.3
repository_type: pipeline
template:
author: Martin Beracochea, Ekaterina Sakharova, Sofia Ochkalova, Evangelos Karatzas, Tim Rozday
author: Martin Beracochea, Ekaterina Sakharova, Sofia Ochkalova, Evangelos Karatzas,
Tim Rozday
description: Submit sequences, assemblies, MAGs, etc., to public archives
force: false
is_nfcore: true
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## v1.0.0 - [date]
## v1.0.0 - 01/08/2026

Initial release of nf-core/seqsubmit, created with the [nf-core](https://nf-co.re/) template.

Expand Down
247 changes: 49 additions & 198 deletions README.md

Large diffs are not rendered by default.

32 changes: 20 additions & 12 deletions assets/schema_input_assembly.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@
"items": {
"type": "object",
"properties": {
"sample": {
"id": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Sample must be provided and cannot contain spaces",
"description": "A unique identifier for this data entry. Must be globally unique within the input dataset",
"errorMessage": "ID must be provided and cannot contain spaces",
"meta": ["id"]
},
"fasta": {
Expand All @@ -19,7 +20,7 @@
"exists": true,
"pattern": "^([\\S\\s]*\\/)?[^\\s\\/]+\\.(fa|fasta|fna)\\.gz$",
"errorMessage": "FASTA file must be provided and have extension '.fa.gz', '.fasta.gz', '.fna.gz'",
"description": "Metagenomic assembly FASTA file"
"description": "Path to assembly contigs in FASTA format compressed with gzip"
},
"fastq_1": {
"anyOf": [
Expand All @@ -34,8 +35,9 @@
"maxLength": 0
}
],
"default": null,
"errorMessage": "FASTQ file must have extension '.fq' or '.fastq' (optionally gzipped)",
"description": "Forward reads if paired-end or single-end reads FASTQ file"
"description": "Path to single-end/paired-end forward reads in FASTQ format (optionally gzipped). Required if coverage is not provided"
},
"fastq_2": {
"anyOf": [
Expand All @@ -50,43 +52,49 @@
"maxLength": 0
}
],
"default": null,
"errorMessage": "FASTQ file for reverse reads must have extension '.fq' or '.fastq' (optionally gzipped)",
"description": "Reverse reads FASTQ file if paired-end. Leave empty for single-end reads"
"description": "Path to reverse reads in FASTQ format for paired-end data (optionally gzipped). Leave empty for single-end reads"
},
"coverage": {
"anyOf": [
{
"type": "number",
"minimum": 0
"exclusiveMinimum": 0
},
{
"type": "string",
"maxLength": 0
}
],
"default": null,
"errorMessage": "Coverage must be a positive number or empty",
"description": "Estimated value of assembly coverage"
"description": "Estimated sequencing depth of the assembly (optional). If this value is missing, it is computed automatically during pipeline execution when reads are provided",
"meta": ["coverage"]
},
"run_accession": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Accession must be provided and cannot contain spaces",
"description": "Accession of the run used to generate the assembly"
"description": "ENA run accession for the reads used to generate the metagenomic assembly. Reads must already be submitted to ENA",
"meta": ["run_accession"]
},
"assembler": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Assembler must be provided and cannot contain spaces",
"description": "Name of the assembler software used to generate the assembly"
"description": "Name of the assembler software used to generate the assembly, e.g. MEGAHIT, SPAdes, metaSPAdes, Flye, etc",
"meta": ["assembler"]
},
"assembler_version": {
"anyOf": [{ "type": "string" }, { "type": "number" }],
"pattern": "^\\S+$",
"errorMessage": "Assembler version must be provided and cannot contain spaces",
"description": "Version of the assembler software used to generate the assembly"
"description": "Version of the assembler software used to generate the assembly, e.g. 1.0.0",
"meta": ["assembler_version"]
}
},
"required": ["sample", "fasta", "run_accession", "assembler", "assembler_version"],
"required": ["id", "fasta", "run_accession", "assembler", "assembler_version"],
"anyOf": [
{
"properties": {
Expand All @@ -101,7 +109,7 @@
"properties": {
"coverage": {
"type": "number",
"minimum": 0
"exclusiveMinimum": 0
}
},
"required": ["coverage"]
Expand Down
117 changes: 89 additions & 28 deletions assets/schema_input_genome.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,25 @@
"items": {
"type": "object",
"properties": {
"sample": {
"id": {
"type": "string",
"pattern": "^\\S+$",
"errorMessage": "Sample name must be provided and cannot contain spaces",
"description": "A unique identifier for this data entry. Must be globally unique within the input dataset",
"errorMessage": "ID must be provided and cannot contain spaces",
"meta": ["id"]
},
"fasta": {
"type": "string",
"format": "file-path",
"exists": true,
"pattern": "^([\\S\\s]*\\/)?[^\\s\\/]+\\.(fa|fasta|fna)\\.gz$",
"errorMessage": "FASTA file for sequences 1 must be provided, cannot contain spaces and must have extension '.fa.gz', '.fasta.gz', or '.fna.gz'",
"description": "MAG/bin sequence file"
"errorMessage": "Path to the FASTA file must be provided, cannot contain spaces and must have extension '.fa.gz', '.fasta.gz', or '.fna.gz'",
"description": "Path to MAG/bin sequences in FASTA format compressed with `gzip`. All names of the FASTA files must be unique to prevent pipeline errors. File should contain at least one sequence"
},
"accession": {
"type": "string",
"description": "Run or assembly ENA accession"
"description": "ENA accession of the run or metagenomic assembly used to generate the MAG/bin. Reads or assembly must already be submitted to ENA",
"meta": ["accession"]
},
"fastq_1": {
"anyOf": [
Expand All @@ -38,8 +40,9 @@
"maxLength": 0
}
],
"default": null,
"errorMessage": "FASTQ file must have extension '.fq' or '.fastq' (optionally gzipped)",
"description": "Forward reads if paired-end or single-end reads FASTQ file"
"description": "Path to single-end/paired-end forward reads (in FASTQ format, optionally gzipped) used to generate the source metagenomic assembly. Required if genome_coverage is not provided"
},
"fastq_2": {
"anyOf": [
Expand All @@ -54,68 +57,126 @@
"maxLength": 0
}
],
"default": null,
"errorMessage": "FASTQ file for reverse reads must have extension '.fq' or '.fastq' (optionally gzipped)",
"description": "Reverse reads FASTQ file if paired-end. Leave empty for single-end reads"
"description": "Path to reverse reads in FASTQ format for paired-end data (optionally gzipped) used to generate the source metagenomic assembly. Leave empty for single-end reads"
},
"assembly_software": {
"type": "string",
"description": "Tool name and version that was used to assemble data"
"description": "Tool name and version that was used to assemble data, e.g. MEGAHIT_v1.0, SPAdes_v4.0.0, metaSPAdes_v3.15.0",
"meta": ["assembly_software"]
},
"binning_software": {
"type": "string",
"description": "Tool name and version that was used to bin data"
"description": "Tool name and version that was used to bin data, e.g. MetaBAT2_v1.0, VAMB_2.0, MaxBin2_v1, CONCOCT_v3.0, SemiBin2_v1, COMEBin_v2.3.4, etc",
"meta": ["binning_software"]
},
"binning_parameters": {
"type": "string",
"description": "Arguments used to bin data different from default"
"description": "Arguments used to bin data different from default, e.g. -min_contig_length 1000, otherwise use 'default'",
"meta": ["binning_parameters"]
},
"stats_generation_software": {
"type": "string",
"description": "Tool(s) used to estimate completeness and contamination"
"default": null,
"description": "Tool, including version, that was used to calculate completeness and contamination, e.g. CheckM2_v1.0.0",
"meta": ["stats_generation_software"]
},
"completeness": {
"type": "number",
"description": "MAG/bin completeness value"
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 100
},
{
"type": "string",
"maxLength": 0
}
],
"default": null,
"description": "MAG/bin completeness score: the 0<= ratio <= 100 of observed single-copy marker genes to total single-copy marker genes in chosen marker gene set (%). ENA docs: https://ena-docs.readthedocs.io/en/latest/faq/metagenomes.html#how-is-the-quality-of-a-metagenomic-assembly-defined",
"meta": ["completeness"]
},
"contamination": {
"type": "number",
"description": "MAG/bin contamination value"
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 100
},
{
"type": "string",
"maxLength": 0
}
],
"default": null,
"description": "MAG/bin contamination score: the 0<= ratio <= 100 of observed single-copy marker genes in ≥2 copies to total single-copy marker genes in chosen marker gene set (%). ENA docs: https://ena-docs.readthedocs.io/en/latest/faq/metagenomes.html#how-is-the-quality-of-a-metagenomic-assembly-defined",
"meta": ["contamination"]
},
"genome_coverage": {
"type": "number",
"description": "MAG/bin coverage value"
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "string",
"maxLength": 0
}
],
"default": null,
"description": "Estimated average sequencing depth (>0) across the genome. If the value is missing, it is computed automatically during pipeline execution when reads are provided",
"meta": ["genome_coverage"]
},
"metagenome": {
"type": "string",
"description": "ENA accepted metagenome name"
"description": "Registered metagenome taxonomic identifier or name that matches an existing ENA taxonomy entry. It needs to be listed in the taxonomy tree https://www.ebi.ac.uk/ena/browser/view/408169?show=tax-tree (you might need to press \"Tax tree - Show\" in the right most section of the page). Full list can also be found https://github.com/EBI-Metagenomics/genome_uploader/blob/main/genomeuploader/constants.py#L22",
"meta": ["metagenome"]
},
"co-assembly": {
"type": "string",
"description": "Yes if data was co-assembled, No otherwise"
"type": "boolean",
"description": "Whether a co-assembly strategy was used for the initial metagenomic assembly generation. Options: 'true' or 'false'",
"meta": ["co_assembly"]
},
"broad_environment": {
"type": "string",
"description": "broad ecological context of a sample"
"description": "Broad ecological context of the sample, for example 'marine biome', 'desert biome'. It is recommended to use subclasses of EnvO 'biome' class (http://purl.obolibrary.org/obo/ENVO_00000428). Documentation: https://github.com/EnvironmentOntology/envo/wiki/Using-ENVO-with-MIxS",
"meta": ["broad_environment"]
},
"local_environment": {
"type": "string",
"description": "local ecological context"
"description": "Local environmental context of the sample, for example 'tropical dry broadleaf forest biome', 'marine abyssal zone biome'. It is recommended to use EnvO terms which are of smaller spatial grain than your entry for \"broad-scale environmental context\". Documentation: https://github.com/EnvironmentOntology/envo/wiki/Using-ENVO-with-MIxS",
"meta": ["local_environment"]
},
"environmental_medium": {
"type": "string",
"description": "material displaced by the sample"
"description": "Material surrounding and in contact with the sample, for example 'mucus', 'lake water'. It is recommended to use subclasses of EnvO 'environmental material' class (http://purl.obolibrary.org/obo/ENVO_00010483). Documentation: https://github.com/EnvironmentOntology/envo/wiki/Using-ENVO-with-MIxS",
"meta": ["environmental_medium"]
},
"RNA_presence": {
"type": "string",
"description": "Yes/No if at least 18 tRNAs and 5S, 16S, 23S rRNA genes detected"
"anyOf": [
{
"type": "boolean"
},
{
"type": "string",
"maxLength": 0
}
],
"default": null,
"description": "Presence or absence of the 23S, 16S, and 5S rRNA genes and at least 18 tRNAs. This is used for MISAG/MIMAG assembly quality classification. Options: 'true' or 'false'",
"meta": ["RNA_presence"]
},
"NCBI_lineage": {
"type": "string",
"description": "full NCBI lineage - format: x;y;z"
"default": null,
"description": "Full NCBI lineage - format: x;y;z. For example, the lineage for E. coli can be: 'Bacteria;Pseudomonadati;Pseudomonadota;Gammaproteobacteria;Enterobacterales;Enterobacteriaceae;Escherichia' or '2;1224;1236;91347;543;561;562'. For more info check https://www.ncbi.nlm.nih.gov/datasets/docs/v2/data-processing/taxonomy-processing/taxonomy/",
"meta": ["NCBI_lineage"]
}
},
"required": [
"sample",
"id",
"fasta",
"accession",
"assembly_software",
Expand All @@ -141,7 +202,7 @@
"properties": {
"genome_coverage": {
"type": "number",
"minimum": 0
"exclusiveMinimum": 0
}
},
"required": ["genome_coverage"]
Expand Down
Loading
Loading