Skip to content

Common Functions

This module provides core utilities and constants used throughout the FMDData.jl package for processing Foot-and-Mouth Disease seroprevalence data.

Main Module

The main FMDData module that orchestrates all data processing functionality:

FMDData Module
julia
FMDData

A Julia package for cleaning and processing Foot-and-Mouth Disease (FMD) seroprevalence data from Indian Council of Agricultural Research (ICAR) annual reports.

source

Constants

Package-wide constants that define standard values and configurations:

FMDData.default_allowed_serotypes Constant
julia
default_allowed_serotypes

A vector of default allowed serotype names for FMD data processing. Contains the three main FMD serotypes: "o", "a", and "asia1".

source

Utility Functions

Core utility functions that support data processing operations across the package.

Directory Management

Functions for managing file paths and directory structures used in the data processing pipeline:

FMDData.input_dir Function
julia
input_dir(args...)

Returns the absolute path to the inputs directory of the project.

source
FMDData.icar_inputs_dir Function
julia
icar_inputs_dir(args...)

Returns the absolute path to the extracted-seroprevalence-tables directory, which contains the raw ICAR report data.

source
FMDData.icar_outputs_dir Function
julia
icar_outputs_dir(args...)

Returns the absolute path to the icar-seroprevalence directory, which contains the cleaned and processed data.

source
FMDData.icar_cleaned_dir Function
julia
icar_cleaned_dir(args...)

Returns the absolute path to the cleaned directory, which contains the cleaned ICAR report data.

source
FMDData.icar_processed_dir Function
julia
icar_processed_dir(args...)

Returns the absolute path to the processed directory, which contains the processed ICAR report data.

source

Data Processing Utilities

Helper functions for common data manipulation tasks and filtering operations:

FMDData.skip_missing_and_nan Function
julia
skip_missing_and_nan

Convenience function to skip missing and/or NaN values in a iterator.

Returns another iterator.

source
FMDData.skip_nothing Function
julia
skip_nothing

Convenience function to skip nothing values in an iterator

Returns another iterator.

source
FMDData.update_regex Function
julia
update_regex(
    original_reg::Regex,
    find_reg::Regex,
    substitution_str::SubstitutionString
)

Update a Regex string using regex and a substitution string.

source