Files
obitools4/autodoc/docmd/pkg/obitools/obirefidx/options.md
T
Eric Coissac 8c7017a99d ⬆️ version bump to v4.5
- Update obioptions.Version from "Release 4.4.29" to "/v/ Release v5"
- Update version.txt from 4.29 → .30
(automated by Makefile)
2026-04-13 13:34:53 +02:00

1.1 KiB

obirefidx Package Overview

The obirefidx package provides command-line option configuration for the obiuniq tool within the OBITools4 ecosystem.

  • Purpose: Extends generic option parsing to support obiuniq's specific flags.
  • Core Function:
    func OptionSet(options *getoptions.GetOpt)
    
  • Behavior:
    Delegates to obiconvert.OptionSet(false), inheriting all standard conversion options (e.g., input/output formats, filtering thresholds), but without enabling verbose mode (false → no extra logging).
  • Dependencies:
    • getoptions: For robust CLI argument parsing.
    • obiconvert: Shared conversion utilities and option definitions.
  • Semantic Role: Acts as a feature gate—ensuring only relevant obiconvert options are exposed to the user for deduplication tasks.
  • Use Case: Used during CLI initialization (e.g., obiuniq --input file.fastq) to validate and bind user-provided flags.

In essence, obirefidx ensures consistent, minimal option exposure for reference-based deduplication workflows in OBITools4.