Skip to content

Commit 257ccc4

Browse files
committed
all ci fixes
1 parent c3c9c3c commit 257ccc4

15 files changed

Lines changed: 50 additions & 80 deletions

base/db/R/get.trait.data.pft.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
##' }
3030
##'
3131
##' **Downstream contract:** The files `trait.data.Rdata` and
32-
##' `prior.distns.Rdata` are expected by \link[PEcAn.meta.analysis]{run.meta.analysis.pft}], which
32+
##' `prior.distns.Rdata` are expected by \code{\link[PEcAn.MA]{run.meta.analysis.pft}}, which
3333
##' loads them from `pft$outdir`. This implicit file-based coupling means
3434
##' the two functions must agree on directory path and object names. A future
3535
##' refactoring goal is to pass these objects directly via function arguments

base/db/man/get.trait.data.pft.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

base/workflow/R/run.write.configs.R

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
#' @details
1010
#' **Upstream contract (reads from `settings$outdir`):**
1111
#' \describe{
12-
#' \item{`samples.Rdata`}{Produced by `get.parameter.samples()` in
13-
#' `PEcAn.uncertainty`. Contains 5 bundled objects: `trait.samples`,
12+
#' \item{`samples.Rdata`}{Produced by \code{\link[PEcAn.uncertainty]{get.parameter.samples}}.
13+
#' Contains 5 bundled objects: `trait.samples`,
1414
#' `sa.samples`, `ensemble.samples`, `runs.samples`, `env.samples`.
1515
#' This function loads `trait.samples` and `sa.samples` to build
1616
#' model configuration files. If `input_design` contains a `param`
@@ -32,9 +32,9 @@
3232
#' }
3333
#'
3434
#' **Downstream contract:** The `sensitivity.samples.*.Rdata` and
35-
#' `ensemble.samples.*.Rdata` files are loaded by `get.results()` (in
36-
#' `PEcAn.uncertainty`) to match model outputs to their corresponding
37-
#' parameter sets. This implicit file-based coupling is a refactoring target.
35+
#' `ensemble.samples.*.Rdata` files are loaded by \code{\link[PEcAn.uncertainty]{get.results}}
36+
#' to match model outputs to their corresponding
37+
#' parameter sets. This implicit file-based coupling is a refactoring target.
3838
#'
3939
#' The default value for `posterior.files` is NA, in which case the
4040
#' most recent posterior or prior (in that order) for the workflow is used.
@@ -47,7 +47,7 @@
4747
#' @param ensemble.size number of ensemble runs
4848
#' @param input_design Input design data.frame coordinating input files across
4949
#' runs. Contains columns for each sampled input (met, param, etc.) with row
50-
#' indices, as documented in `runModule.run.write.configs()`.
50+
#' indices, as documented in \code{\link[PEcAn.workflow]{runModule.run.write.configs}}.
5151
#' @param write should the runs be written to the database?
5252
#' @param posterior.files Filenames for posteriors for drawing samples for
5353
#' ensemble and sensitivity analysis (e.g. `post.distns.Rdata`, or

base/workflow/man/run.write.configs.Rd

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

modules/meta.analysis/R/run.meta.analysis.R

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -186,17 +186,17 @@ check_consistent <- function(point, prior,
186186
#' #' Run Bayesian meta-analysis for a single PFT (file-based wrapper)
187187
#'
188188
#' @md
189-
#' Thin wrapper around [meta_analysis_standalone()] that reads trait data and
189+
#' Thin wrapper around \code{\link[PEcAn.MA]{meta_analysis_standalone}} that reads trait data and
190190
#' priors from disk, runs the meta-analysis, and saves results back to disk.
191191
#' Also registers result files in the BETYdb posteriors table.
192192
#'
193193
#' @details
194194
#' **Upstream contract (reads from `pft$outdir`):**
195195
#' \describe{
196196
#' \item{`trait.data.Rdata`}{Named list of data frames produced by
197-
#' [get.trait.data.pft()]. Loaded into `trait_env$trait.data`.}
197+
#' \code{\link[PEcAn.DB]{get.trait.data.pft}}. Loaded into `trait_env$trait.data`.}
198198
#' \item{`prior.distns.Rdata`}{Data frame of prior distributions produced by
199-
#' [get.trait.data.pft()]. Loaded into `prior_env$prior.distns`.}
199+
#' \code{\link[PEcAn.DB]{get.trait.data.pft}}. Loaded into `prior_env$prior.distns`.}
200200
#' }
201201
#'
202202
#' **File-based side effects (saved to `pft$outdir`):**
@@ -206,20 +206,20 @@ check_consistent <- function(point, prior,
206206
#' JAGS. Each element has columns `beta.o` (overall mean) and optionally
207207
#' `sd.o` (overall SD).}
208208
#' \item{`post.distns.MA.Rdata`}{Contains `post.distns`: a data frame with
209-
#' one row per trait and columns `distn`, `parama`, `paramb`, `n`
209+
#' one row per trait and columns `distn`, `parama`, `paramb`, `n`}
210210
#' summarizing the fitted posterior distribution.}
211211
#' \item{`post.distns.Rdata`}{Symlink to `post.distns.MA.Rdata`.}
212212
#' \item{`jagged.data.Rdata`}{Contains `jagged.data`: a named list of data
213213
#' frames (one per trait) formatted for use in the JAGS meta-analysis
214-
#' model (see [jagify()]).}
214+
#' model (see \code{\link[PEcAn.MA]{jagify}}).}
215215
#' }
216216
#'
217217
#' **Downstream contract:** The files `trait.mcmc.Rdata` and
218-
#' `post.distns.Rdata` are expected by \link[PEcAn.uncertainty]{get.parameter.samples} (in
218+
#' `post.distns.Rdata` are expected by \code{\link[PEcAn.uncertainty]{get.parameter.samples}} (in
219219
#' `PEcAn.uncertainty`), which loads them to generate ensemble and sensitivity
220220
#' analysis samples.
221221
#'
222-
#' **Note:** The core computation is performed by [meta_analysis_standalone()],
222+
#' **Note:** The core computation is performed by \code{\link[PEcAn.MA]{meta_analysis_standalone}},
223223
#' which accepts and returns R objects directly — see its documentation for
224224
#' the pure-function interface.
225225
#'
@@ -352,8 +352,8 @@ run.meta.analysis.pft <- function(pft, iterations, random = TRUE, threshold = 1.
352352
##' Run meta-analysis across all PFTs
353353
##'
354354
##' @md
355-
##' Iterates over a list of PFTs and runs [run.meta.analysis.pft()] for each
356-
##' one. This is the main entry point called by [runModule.run.meta.analysis()].
355+
##' Iterates over a list of PFTs and runs \code{\link[PEcAn.MA]{run.meta.analysis.pft}} for each
356+
##' one. This is the main entry point called by \code{\link[PEcAn.MA]{runModule.run.meta.analysis}}.
357357
##'
358358
##' This will use the following items from settings:
359359
##' - `settings$pfts`
@@ -365,7 +365,7 @@ run.meta.analysis.pft <- function(pft, iterations, random = TRUE, threshold = 1.
365365
##' @param database database connection parameters
366366
##' @param update logical: Rerun the meta-analysis if result files already exist?
367367
##' @param threshold Gelman-Rubin convergence diagnostic, passed on to
368-
##' [pecan.ma.summary()]
368+
##' \code{\link{pecan.ma.summary}}
369369
##' @inheritParams meta_analysis_standalone
370370
##' @inheritParams run.meta.analysis.pft
371371
##'

modules/meta.analysis/man/run.meta.analysis.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

modules/meta.analysis/man/run.meta.analysis.pft.Rd

Lines changed: 0 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

modules/uncertainty/R/get.parameter.samples.R

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
#' Loads posterior distributions and MCMC chain results from disk, generates
55
#' parameter samples for ensemble and sensitivity analysis runs, and optionally
66
#' saves results to `samples.Rdata`. This is the backward-compatible wrapper
7-
#' that delegates computation to [get_parameter_samples()].
7+
#' that delegates computation to \code{\link[PEcAn.uncertainty]{get_parameter_samples}}.
88
#'
99
#' @details
1010
#' **Upstream contract (reads from each PFT's `outdir`):**
1111
#' \\describe{
1212
#' \\item{`post.distns.Rdata` or `prior.distns.Rdata`}{Posterior (or prior)
13-
#' distribution summaries produced by [run.meta.analysis.pft()]. A data
13+
#' distribution summaries produced by \code{\link[PEcAn.MA]{run.meta.analysis.pft}}. A data
1414
#' frame with columns `distn`, `parama`, `paramb`, `n`.}
1515
#' \\item{`trait.mcmc.Rdata`}{(Optional) MCMC chain samples from the
1616
#' meta-analysis. Named list of `mcmc.list` objects, one per trait.
@@ -35,9 +35,9 @@
3535
#' }}
3636
#' }
3737
#'
38-
#' **Downstream contract:** `samples.Rdata` is loaded by [run.write.configs()]
38+
#' **Downstream contract:** `samples.Rdata` is loaded by \code{\link[PEcAn.workflow]{run.write.configs}}
3939
#' (in `PEcAn.workflow`) to generate model configuration files. It is also
40-
#' loaded by [get.results()] and [run.sensitivity.analysis()] to retrieve
40+
#' loaded by \code{\link[PEcAn.uncertainty]{get.results}} and \code{\link[PEcAn.uncertainty]{run.sensitivity.analysis}} to retrieve
4141
#' sample metadata for post-processing. This implicit file-based coupling is
4242
#' a refactoring target.
4343
#'

modules/uncertainty/R/get.results.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
##' @md
44
##' Loads sample metadata and run IDs from disk, reads model output for each
55
##' run, and saves parsed results for downstream analysis by
6-
##' [run.sensitivity.analysis()] and [run.ensemble.analysis()].
6+
##' \code{\link[PEcAn.uncertainty]{run.sensitivity.analysis}} and \code{\link[PEcAn.uncertainty]{run.ensemble.analysis}}.
77
##'
88
##' Output is placed in model output directory (`settings$outdir`).
99
##'
@@ -12,10 +12,10 @@
1212
##' \describe{
1313
##' \item{`sensitivity.samples.<id>.Rdata` or `samples.Rdata`}{Loaded to
1414
##' obtain `sa.run.ids`, `pft.names`, `trait.names`, and `sa.samples` for
15-
##' sensitivity analysis. Produced by [run.write.configs()].}
15+
##' sensitivity analysis. Produced by \code{\link[PEcAn.workflow]{run.write.configs}}.}
1616
##' \item{`ensemble.samples.<id>.Rdata` or `samples.Rdata`}{Loaded to obtain
1717
##' `ens.run.ids`, `pft.names`, and `trait.names` for ensemble analysis.
18-
##' Produced by [run.write.configs()].}
18+
##' Produced by \code{\link[PEcAn.workflow]{run.write.configs}}.}
1919
##' }
2020
##'
2121
##' **File-based side effects (saved to `settings$outdir`):**
@@ -30,8 +30,8 @@
3030
##' }
3131
##'
3232
##' **Downstream contract:** `sensitivity.output.*.Rdata` is loaded by
33-
##' [run.sensitivity.analysis()]. `ensemble.output.*.Rdata` is loaded by
34-
##' [run.ensemble.analysis()]. Both use these files to compute diagnostics
33+
##' \code{\link[PEcAn.uncertainty]{run.sensitivity.analysis}}. `ensemble.output.*.Rdata` is loaded by
34+
##' \code{\link[PEcAn.uncertainty]{run.ensemble.analysis}}. Both use these files to compute diagnostics
3535
##' and plots. This implicit file-based coupling is a refactoring target.
3636
##'
3737
##' @export

modules/uncertainty/R/run.ensemble.analysis.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
#' **Upstream contract (reads from `settings$outdir`):**
1010
#' \describe{
1111
#' \item{`ensemble.output.<var>.<years>.<id>.Rdata`}{Produced by
12-
#' [get.results()]. Contains `ensemble.output`: a numeric vector of
12+
#' \code{\link[PEcAn.uncertainty]{get.results}}. Contains `ensemble.output`: a numeric vector of
1313
#' model output values, one per ensemble member.}
1414
#' }
1515
#'
@@ -34,7 +34,7 @@
3434
#' @param ensemble.id database ID, taken from settings if not specified
3535
#' @param variable variable name to process, taken from settings if not specified
3636
#' @param start.year,end.year taken from settings if not specified
37-
#' @param ... additional arguments passed to [ensemble.ts()]
37+
#' @param ... additional arguments passed to \code{\link[PEcAn.uncertainty]{ensemble.ts}}
3838
#'
3939
#' @return Nothing (called for side effects). Creates ensemble plots as PDF
4040
#' files and optionally saves time series analysis results.

0 commit comments

Comments
 (0)