Skip to content

Commit

Permalink
::document()
Browse files Browse the repository at this point in the history
  • Loading branch information
mattfidler committed Dec 1, 2023
1 parent 6e81933 commit 0056100
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 36 deletions.
32 changes: 16 additions & 16 deletions R/rxode2.R
Original file line number Diff line number Diff line change
Expand Up @@ -1244,13 +1244,13 @@ rxDllLoaded <- rxIsLoaded
#'
#' @return An rxDll object that has the following components
#'
#' * `dll`{DLL path}
#' * `model`{model specification}
#' * `.c`{A function to call C code in the correct context from the DLL
#' using the [.C()] function.}
#' * `.call`{A function to call C code in the correct context from the DLL
#' using the [.Call()] function.}
#' * `args`{A list of the arguments used to create the rxDll object.}
#' * `dll` DLL path
#' * `model` model specification
#' * `.c` A function to call C code in the correct context from the DLL
#' using the [.C()] function.
#' * `.call` A function to call C code in the correct context from the DLL
#' using the [.Call()] function.
#' * `args` A list of the arguments used to create the rxDll object.
#' @inheritParams rxode2
#' @seealso [rxode2()]
#' @author Matthew L.Fidler
Expand Down Expand Up @@ -1776,17 +1776,17 @@ rxModels_ <- # nolint
#'
#' @return A list of rxode2 model properties including:
#'
#' * `params`{ a character vector of names of the model parameters}
#' * `lhs`{ a character vector of the names of the model calculated parameters}
#' * `state`{ a character vector of the compartments in rxode2 object}
#' * `trans`{ a named vector of translated model properties
#' * `params` a character vector of names of the model parameters
#' * `lhs` a character vector of the names of the model calculated parameters
#' * `state` a character vector of the compartments in rxode2 object
#' * `trans` a named vector of translated model properties
#' including what type of jacobian is specified, the `C` function prefixes,
#' as well as the `C` functions names to be called through the compiled model.}
#' * `md5`{a named vector that gives the digest of the model (`file_md5`) and the parsed model
#' (`parsed_md5`)}
#' * `model`{ a named vector giving the input model (`model`),
#' as well as the `C` functions names to be called through the compiled model.
#' * `md5` a named vector that gives the digest of the model (`file_md5`) and the parsed model
#' (`parsed_md5`)
#' * `model` a named vector giving the input model (`model`),
#' normalized model (no comments and standard syntax for parsing, `normModel`),
#' and interim code that is used to generate the final C file `parseModel`}
#' and interim code that is used to generate the final C file `parseModel`
#'
#' @keywords internal
#' @family Query model information
Expand Down
1 change: 0 additions & 1 deletion man/reexports.Rd

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

14 changes: 7 additions & 7 deletions man/rxCompile.Rd

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

18 changes: 9 additions & 9 deletions man/rxModelVars.Rd

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

2 changes: 1 addition & 1 deletion man/rxSetPipingAuto.Rd

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

4 changes: 2 additions & 2 deletions man/rxode2.Rd

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

0 comments on commit 0056100

Please sign in to comment.