schoenerd 0.1.0

Schoener's D index calculator for niche overlap.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use crate::input;
use std::{error, fmt, io, path::PathBuf};

/// Top level errors.
#[derive(Debug)]
pub enum Error {
    /// Unable to access input file.
    InputFile { path: PathBuf, error: io::Error },
    /// Input file was not provided and no input was piped via stdin.
    MissingInput,
    /// Unable to parse headers from input data.
    ParseHeaders(csv::Error),
    /// Insufficient number of columns (pollinators) in input data:
    /// required at least two species of pollinators.
    InsufficientInputColumns { pollinators: Vec<String> },
    /// Unable to read input CSV record.
    ReadRecord(csv::Error),
    /// Unable to parse numeric input field as f64.
    InvalidFieldValue(input::ParseFieldError),
    /// Missing plant identifier in input record.
    MissingPlantIdent {
        /// Missing plant line number.
        line_nr: usize,
    },
    /// Duplicate plant in input record.
    DuplicatePlantIdent {
        /// Previous occurrence line number.
        prev_occ_line_nr: usize,
        /// Duplicate line number.
        line_nr: usize,
        /// Plant ident.
        plant: String,
    },
    /// Missing interaction (input) data.
    MissingData,
    /// Unable to create output file.
    OutputFile { path: PathBuf, error: io::Error },
    /// Unable to write output record.
    WriteRecord(csv::Error),
    /// Unable to write output data.
    OutputData(io::Error),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::InputFile { path, error } => {
                write!(f, "unable access input file '{}': {error}", path.display())
            }
            Error::MissingInput => {
                f.write_str("expected either input file or piped input from stdin")
            }
            Error::ParseHeaders(error) => write!(f, "unable to retrieve input headers: {error}"),
            Error::InsufficientInputColumns { pollinators } => {
                let field = pollinators.len();
                write!(
                    f,
                    "insufficient number of columns in input data: required \
                        at least two species of pollinators, found {field}"
                )?;

                if field > 0 {
                    write!(f, " ('{}')", pollinators[0])?;
                }

                Ok(())
            }
            Error::ReadRecord(error) => write!(f, "invalid input record: {error}"),
            Error::InvalidFieldValue(error) => error.fmt(f),
            Error::MissingPlantIdent { line_nr } => {
                write!(f, "missing plant identifier at line {line_nr}")
            }
            Error::DuplicatePlantIdent {
                line_nr: line,
                prev_occ_line_nr,
                plant,
            } => {
                write!(
                    f,
                    "duplicate plant ('{plant}') at line {line}, \
                        previous occurrence at line {prev_occ_line_nr}"
                )
            }
            Error::MissingData => f.write_str(
                "missing plant-pollinator interaction data, \
                    required at least one record",
            ),
            Error::OutputFile { path, error } => write!(
                f,
                "unable to create output file '{}': {error}",
                path.display()
            ),
            Error::WriteRecord(error) => write!(f, "unable to write output record: {error}"),
            Error::OutputData(error) => {
                write!(f, "unable to write output data: {error}")
            }
        }
    }
}

impl error::Error for Error {}

impl From<input::ParseFieldError> for Error {
    fn from(error: input::ParseFieldError) -> Self {
        Error::InvalidFieldValue(error)
    }
}