Skip to main content

Configuration

The main runtime configuration lives in YAML files.

Common files include:

  • bin/config.yaml: default local runtime configuration
  • bin/cnag-hpc-config.yaml: CNAG HPC-oriented configuration
  • testdata/vcf/param.yaml: VCF test configuration
  • testdata/tsv/param.yaml: SNP-array TSV test configuration
  • examples/param_hg38.yaml: GRCh38 / hg38 example configuration

Common Parameters

ParameterPurpose
genomeReference genome label, such as hg19, hg38, hs37, or b37
projectdirOutput project directory
bff2htmlWhether to generate browser-oriented HTML output
annotateWhether the VCF workflow should run annotation
bff.metadatadirDirectory containing metadata BFF JSON collections for loading
bff.genomicVariationsVcfPath to generated genomic variation output

Keep the genome setting aligned with the VCF contig naming and annotation resources used by your installation.