R/para_data.R

In parasiteR: A Theorical-Practical Approach to Parasitological Data Analysis

#' Simulated parasite abundance data for multiple species across hosts and sites
#'
#' This dataset contains hypothetical generated parasite count data representing multiple parasite species infecting individual hosts across different sampling sites. Each row corresponds to a single sampling unit (i.e., an individual host), and parasite abundance is recorded as counts for each parasite species (Sp1–Sp4).
#'
#'The dataset was intentionally constructed to reproduce common scenarios encountered in parasitological studies, rather than to reflect a specific empirical system. These scenarios include:
#'
#'\itemize{
#'    \item zero-inflated parasite distributions
#'    \item aggregated parasite abundances
#'    \item missing data (non-analyzed host–parasite combinations)
#'    \item rare infections (single infected host)
#'    \item absence of infection
#'    \item small sample sizes for specific host–site combinations
#'   }
#'
#'This structure allows testing and demonstrating the behavior of analytical functions under realistic and edge-case conditions.
#'
#' @format ## `para_data`
#' A list with 4 elements
#' \itemize{
#'   \item \code{dataset} A data frame with 81 rows and 6 columns:
#'   \itemize{
#'    \item Site: Factor or character. Sampling location where hosts were collected (sites A, B, C and D). Multiple hosts can belong to the same site.
#'    \item Factor or character. Host species identifier. In this dataset, each site includes up to two host species (HostA, HostB), although some site–host combinations may be absent by design.
#'    \item Sp1: Integer. Abundance (count) of parasite species 1 per host. Simulated using an aggregated (negative binomial) distribution across all sites.
#'    \item Sp2: Integer. Abundance of parasite species 2 per host. Present only in Sites A and B; missing (NA) in Site C to represent non-analyzed combinations.
#'    \item Sp3: Integer. Abundance of parasite species 3 per host. Designed to represent heterogeneous infection patterns: full infection in one host group, rare infection in another and absence elsewhere.
#'    \item Sp4: Integer. Integer. Abundance of parasite species 4 per host. Includes several edge cases:only one host examined, no infected hosts, a single infected host, multiple infected hosts.
#'   }
#'   \item \code{factors_v}: A list of columns with factor values.
#'   \item \code{num_v}: A list of columns with numeric values.
#'   \item \code{summ}: A summary of the loaded data. Check \code{\link[base]{summary}}.
#' }
"para_data"