Add the corresponding documentation

[GeraldineGomez]

https://github.com/epiverse-trace/serofoi/blob/e34ae0496e2ee7c6105f73387c0cf073b224da19/R/validation.R#L1C1-L1C2

serofoi/R/validation.R

Line 41 in e34ae04

validate_survey_features <- function(survey_features) {

serofoi/R/validation.R

Line 63 in e34ae04

validate_foi_df <- function(foi_df, cnames_additional) {

serofoi/R/validation.R

Line 81 in e34ae04

validate_seroreversion_rate <- function(seroreversion_rate) {

serofoi/R/validation.R

Line 87 in e34ae04

validate_survey_and_foi_consistency <- function( #nolint

serofoi/R/validation.R

Line 99 in e34ae04

validate_survey_and_foi_consistency_age_time <- function( #nolint

serofoi/R/validation.R

Line 111 in e34ae04

validate_foi_index <- function(

serofoi/R/simulate_serosurvey.R

Line 496 in e34ae04

check_age_constraints <- function(df) {

serofoi/R/simulate_serosurvey.R

Line 507 in e34ae04

generate_seropositive_counts_by_age_bin <- function( #nolint

Documentation of Internal documentation

You can document internal functions in two ways:

1. Using @keywords internal: This generates documentation for the function, but it will not appear in the index of the manual or the webpage:

#' @title
#' @description
#' @param
#' @return
#' @Keywords internal

2. Using @noRd: If you do not want to generate any documentation in the index or manual:

#' @title
#' @description
#' @param
#' @return None
#' @nord