Skip to content

Commit

Permalink
add global doc
Browse files Browse the repository at this point in the history
  • Loading branch information
super-lou committed Aug 29, 2024
1 parent 53e472a commit 8530dc7
Show file tree
Hide file tree
Showing 9 changed files with 38 additions and 30 deletions.
6 changes: 3 additions & 3 deletions R/CARD_management.R
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@
#' @return CARD parameterization files will be copied and pasted from `CARD_path` and organized according to the structure given by [layout] into the `CARD_out` directory.
#'
#' @seealso
#' [process_extraction()] for extracting variables.
#' [process_trend()] for performing trend analysis on extracted variables.
#' [CARD_extraction()] for extracting variables using CARD parameterization files.
#' - [process_extraction()] for extracting variables.
#' - [process_trend()] for performing trend analysis on extracted variables.
#' - [CARD_extraction()] for extracting variables using CARD parameterization files.
#'
#' @examples
#' \dontrun{
Expand Down
6 changes: 3 additions & 3 deletions R/CARD_process.R
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ get_last_Process = function (Process) {
#' - The `metaEX` [tibble][tibble::tibble()], which contains the metadata of the extraction from CARDs.
#'
#' @seealso
#' [process_extraction()] for extracting variables.
#' [process_trend()] for performing trend analysis on extracted variables.
#' [CARD_management()] for managing CARD parameterization files.
#' - [process_extraction()] for extracting variables.
#' - [process_trend()] for performing trend analysis on extracted variables.
#' - [CARD_management()] for managing CARD parameterization files.
#'
#' @examples
#' ## Creation of random data set
Expand Down
12 changes: 6 additions & 6 deletions R/EXstat.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@
#'
#' @author
#' Main Developer and Maintainer
#' * Louis Héraut <[email protected]> INRAE
#' - Louis Héraut <[email protected]> INRAE
#'
#' Other Developer
#' * Benjamin Renard <[email protected]> INRAE
#' * Valentin Mansanarez
#' - Benjamin Renard <[email protected]> INRAE
#' - Valentin Mansanarez
#'
#' Other Contributors
#' * Éric Sauquet <[email protected]> INRAE
#' * Jean-Philippe Vidal <[email protected]> INRAE
#' * Nathan Pellerin
#' - Éric Sauquet <[email protected]> INRAE
#' - Jean-Philippe Vidal <[email protected]> INRAE
#' - Nathan Pellerin
#'
#' @seealso
#' - [process_extraction()] for extracting variables.
Expand Down
6 changes: 3 additions & 3 deletions R/process_extraction.R
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@
#' @return A [tibble][tibble::tibble()] containing the extracted variable, or a named [list][base::list()] of [tibble][tibble::tibble()] for each extracted variable if `expand` is `TRUE`. This output follows the same format as the input data described in `data`, making it possible to iterate over this output using [process_extraction()].
#'
#' @seealso
#' [process_trend()] for performing trend analysis on extracted variables.
#' [CARD_extraction()] for extracting variables using CARD parameterization files.
#' [CARD_management()] for managing CARD parameterization files.
#' - [process_trend()] for performing trend analysis on extracted variables.
#' - [CARD_extraction()] for extracting variables using CARD parameterization files.
#' - [CARD_management()] for managing CARD parameterization files.
#'
#' @examples
#' ## Creation of random data set
Expand Down
6 changes: 3 additions & 3 deletions R/process_trend.R
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@
#' * `change_max` :
#'
#' @seealso
#' [process_extraction()] for extracting variables.
#' [CARD_extraction()] for extracting variables using CARD parameterization files.
#' [CARD_management()] for managing CARD parameterization files.
#' - [process_extraction()] for extracting variables.
#' - [CARD_extraction()] for extracting variables using CARD parameterization files.
#' - [CARD_management()] for managing CARD parameterization files.
#'
#' @examples
#' ## Creation of random data set
Expand Down
8 changes: 5 additions & 3 deletions man/CARD_extraction.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions man/CARD_management.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions man/process_extraction.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions man/process_trend.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8530dc7

Please sign in to comment.