×

nf-core/amulety/embed @ 0.0.0-6c4ed3a

A module to create embeddings of B-cell receptor (BCR) or T-cell receptor (TCR) amino acid sequences using amulety.

Latest version: 0.0.0-6c4ed3a
Total downloads: 5
Source: nf-core/modules
Authors: @ggabernet
Maintainers: @ggabernet

Summary

A module to create embeddings of B-cell receptor (BCR) or T-cell receptor (TCR) amino acid sequences using amulety.

Get started

Add the following snippet to your workflow script to include this module.

include { AMULETY_EMBED } from 'nf-core/amulety/embed'

License

MIT License

Process
Name AMULETY_EMBED
Input 3 channels
#1 tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ]

tsv file

TSV with BCR/TCR nucleotide sequences in AIRR rearrangement format

*.{tsv}
chain string

The chain to use for the embeddings. Can be either 'H' (high diversity chain: BCR heavy or TCR beta or delta), 'L' (low diversity chain: BCR light or TCR alpha or gamma) or 'HL'/'LH' (BCR heavy + light, and TCR alpha + beta or gamma + delta).

model string

The embedding model to use. Options are detailed on the amulety documentation.

Output 3 channels
#1 embedding tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ]

${task.ext.prefix ?: meta.id}.tsv file

TSV with embeddings of BCR or TCR amino acid sequences.

*.tsv
#2 versions_amulety tuple
${task.process} string

The process the versions were collected from

amulety string

The tool name

amulety --help 2>&1 | grep -o 'version [0-9\.]\+' | grep -o '[0-9\.]\+' eval

The command used to generate the version of the tool

#3 embedding_metadata tuple
meta map

Groovy Map containing sample information e.g. [ id:'sample1', single_end:false ]

*metadata.tsv file

TSV with metadata about the embeddings.

*metadata.tsv
Tool Description Homepage
amulety Python package to create embeddings of BCR and TCR amino acid sequences. https://amulety.readthedocs.io/en/latest/
Version 0.0.0-6c4ed3a
Commit ID 6c4ed3a220310b905a1fc9d04f05be2e0837142b
Release Date 23 Apr 2026 15:02:15 (UTC)
Download URL https://registry.nextflow.io/api/v1/modules/nf-core%2Famulety%2Fembed/0.0.0-6c4ed3a/download
OCI Store URL https://public.cr.seqera.io/v2/nextflow/plugin/modules/nf-core/amulety/embed/blobs/sha256:18b01a029c243cb356f63a3b0883eac25ff68acbca01f0563f93a0b43f721f79
Size 3.4 KB
Checksum sha256:18b01a029c243cb356f63a3b0883eac25ff68acbca01f0563f93a0b43f721f79
Downloads 3
Version Date Status Downloads Size
0.0.0-6c4ed3a 23 Apr 2026 15:02:15 (UTC) 3 3.4 KB
0.0.0-0c7146d 08 Apr 2026 18:42:26 (UTC) 2 3.4 KB