Skip to content

Commit

Permalink
Categorize all functions for pkgdown
Browse files Browse the repository at this point in the history
  • Loading branch information
billdenney committed Oct 24, 2024
1 parent ee9dddd commit fcadc42
Show file tree
Hide file tree
Showing 19 changed files with 110 additions and 5 deletions.
1 change: 1 addition & 0 deletions R/assert.R
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,7 @@ warnRxBounded <- function(ui, extra="", .var.name=.vname(ui)) {
#' @return boolean, indicating if the object is a valid initialization data frame
#' @export
#' @author Matthew L. Fidler
#' @family Assertions
#' @examples
#' testIniDf(TRUE)
testIniDf <- function(iniDf) {
Expand Down
3 changes: 1 addition & 2 deletions R/linMod.R
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,8 @@ rxUdfUi.default <- function(fun) {
#' `rxUdfUi()` for details.
#'
#' @export
#'
#' @family User functions
#' @author Matthew L. Fidler
#'
#' @examples
#'
#' linMod(x, 3)
Expand Down
7 changes: 6 additions & 1 deletion R/rudfui.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ rxUdfUiReset()
#' UI functions
#'
#' @return integer greater than 1L
#' @family User functions
#' @export
#' @author Matthew L. Fidler
#' @examples
#'
#' rxUdfUiNum()
#'
rxUdfUiNum <- function() {
if (checkmate::testIntegerish(.udfUiEnv$num, lower=1L, len=1L, any.missing=FALSE)) {
as.integer(.udfUiEnv$num)
Expand Down Expand Up @@ -64,6 +64,7 @@ rxUdfUiIniDf <- function() {
#' Return the lhs parsed language expression
#'
#' @return lhs language expression or NULL
#' @family User functions
#' @export
#' @author Matthew L. Fidler
#' @examples
Expand All @@ -87,6 +88,7 @@ rxUdfUiIniLhs <- function() {
#'
#' @return value of the `modelVariables` being processed or `NULL`.
#'
#' @family User functions
#' @export
#' @author Matthew L. Fidler
#' @examples
Expand All @@ -113,6 +115,7 @@ rxUdfUiMv <- function(value) {
#' @return value of the `data.frame` being processed or `NULL`.
#'
#' @export
#' @family User functions
#' @author Matthew L. Fidler
#' @examples
#'
Expand All @@ -135,6 +138,7 @@ rxUdfUiData <- function(value) {
#' @param value when specified, this assigns the character value of
#' the estimation method or NULL if there is nothing being estimated
#' @return value of the estimation method being processed or NULL
#' @family User functions
#' @export
#' @author Matthew L. Fidler
#' @examples
Expand All @@ -156,6 +160,7 @@ rxUdfUiEst <- function(value) {
#' Returns if the current ui function is being parsed
#'
#' @return logical if the current ui function is being parsed
#' @family User functions
#' @export
#' @author Matthew L. Fidler
#' @examples
Expand Down
13 changes: 13 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ reference:
- rxUiCompress
- rxUiDecompress
- rxode2<-
- testIniDf
- testRxLinCmt
- testRxUnbounded
- update.rxUi
Expand Down Expand Up @@ -160,6 +161,18 @@ reference:
- rxSymInvChol
- swapMatListWithCube
- uppergamma
- title: User functions
contents:
- linMod
- rxIntToBase
- rxIntToLetter
- rxUdfUiData
- rxUdfUiEst
- rxUdfUiIniDf
- rxUdfUiIniLhs
- rxUdfUiMv
- rxUdfUiNum
- rxUdfUiParsing
- title: Internal Functions
contents:
- .cbindOme
Expand Down
1 change: 1 addition & 0 deletions man/assertCompartmentExists.Rd

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

1 change: 1 addition & 0 deletions man/assertCompartmentName.Rd

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

1 change: 1 addition & 0 deletions man/assertCompartmentNew.Rd

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

1 change: 1 addition & 0 deletions man/assertRxUi.Rd

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

1 change: 1 addition & 0 deletions man/assertVariableExists.Rd

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

1 change: 1 addition & 0 deletions man/assertVariableNew.Rd

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

10 changes: 10 additions & 0 deletions man/linMod.Rd

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

10 changes: 10 additions & 0 deletions man/rxUdfUiData.Rd

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

10 changes: 10 additions & 0 deletions man/rxUdfUiEst.Rd

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

10 changes: 10 additions & 0 deletions man/rxUdfUiIniLhs.Rd

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

10 changes: 10 additions & 0 deletions man/rxUdfUiMv.Rd

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

11 changes: 10 additions & 1 deletion man/rxUdfUiNum.Rd

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

10 changes: 10 additions & 0 deletions man/rxUdfUiParsing.Rd

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

11 changes: 11 additions & 0 deletions man/testIniDf.Rd

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

3 changes: 2 additions & 1 deletion man/testRxUnbounded.Rd

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

0 comments on commit fcadc42

Please sign in to comment.