Skip to main content

OrphosConfig

Struct OrphosConfig 

Source
pub struct OrphosConfig {
    pub metagenomic: bool,
    pub closed_ends: bool,
    pub circular: bool,
    pub mask_n_runs: bool,
    pub force_non_sd: bool,
    pub quiet: bool,
    pub output_format: OutputFormat,
    pub translation_table: Option<u8>,
    pub num_threads: Option<usize>,
}
Expand description

Configuration settings for Orphos gene prediction analysis.

This struct controls all aspects of gene prediction including analysis mode, sequence handling, and output formatting.

§Examples

§Default configuration

use orphos_core::config::OrphosConfig;

let config = OrphosConfig::default();

§Custom configuration for closed-ended genomes

use orphos_core::config::{OrphosConfig, OutputFormat};

let config = OrphosConfig {
    closed_ends: true,
    mask_n_runs: true,
    output_format: OutputFormat::Gff,
    ..Default::default()
};

§Metagenomic mode with multiple threads

use orphos_core::config::OrphosConfig;

let config = OrphosConfig {
    metagenomic: true,
    num_threads: Some(8),
    quiet: true,
    ..Default::default()
};

Fields§

§metagenomic: bool

Enable metagenomic mode for fragmented sequences.

When true, uses pre-computed models instead of training on each sequence. Recommended for:

  • Short contigs (< 100 kb)
  • Mixed community samples
  • Fragmented assemblies

Default: false (single genome mode)

§closed_ends: bool

Treat sequences as having closed ends (complete genomes).

When true, prevents genes from extending off sequence edges. This does not enable wraparound gene detection; use circular for that.

Default: false (allow edge genes)

§circular: bool

Treat sequences as circular topology for wraparound gene detection.

When true, sequence end and start are treated as adjacent so genes can span the breakpoint. This is independent from closed_ends.

Default: false (linear topology)

§mask_n_runs: bool

Mask runs of N characters during analysis.

When true, treats stretches of N’s as gaps and prevents genes from spanning them. Useful for draft genomes with gaps.

Default: false

§force_non_sd: bool

Force use of non-Shine-Dalgarno models for start recognition.

When true, disables detection of ribosome binding sites. Rarely needed except for organisms without canonical RBS.

Default: false (auto-detect)

§quiet: bool

Suppress informational output during processing.

When true, prevents progress messages and statistics from being printed to stderr.

Default: false

§output_format: OutputFormat

Output format for gene prediction results.

Controls the format of generated output files. See OutputFormat for available options.

Default: OutputFormat::Genbank

§translation_table: Option<u8>

Genetic code translation table number (1-25).

Specifies which genetic code to use for translation:

  • 11: Bacterial/Archaeal (most common, default)
  • 4: Mycoplasma/Spiroplasma
  • Others: See NCBI genetic code tables

Default: None (auto-detect, usually table 11)

§num_threads: Option<usize>

Number of threads to use for parallel processing.

When set, configures Rayon thread pool for parallel analysis of multiple sequences. Set to None for automatic detection.

Default: None (use all available cores)

Trait Implementations§

Source§

impl Clone for OrphosConfig

Source§

fn clone(&self) -> OrphosConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OrphosConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for OrphosConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V