Skip to content

Commit

Permalink
fix Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Yunuuuu committed Jun 29, 2024
1 parent 3bda1c9 commit 9b88ea3
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 17 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ biocViews: Software, DataImport, BiomedicalInformatics, Pharmacogenomics, Pharma
Encoding: UTF-8
ByteCompile: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.0
RoxygenNote: 7.3.1.9000
Config/testthat/edition: 3
Config/testthat/parallel: true
VignetteBuilder: knitr
Expand Down
13 changes: 6 additions & 7 deletions R/signal.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
#' - `faers_phv_signal`: Pharmacovigilance Analysis used contingency table
#' constructed with `faers_phv_table`. You must pass `.full` or `.object2`
#' into `faers_phv_table`.
#' @param .object A [FAERSascii] object. The value `n11` or `a` will be
#' calculated from `.object`. The unique number of primaryids will be regarded
#' as `n1.`.
#' @param .object A [FAERSascii] object. The unique number of `primaryids` from
#' `.object` will be regarded as `n1.`.
#' @param ... Other arguments passed to specific methods.
#' - `faers_phv_table`: other arguments passed to [faers_counts].
#' - `faers_phv_signal`: other arguments passed to `faers_phv_table`.
Expand Down Expand Up @@ -42,8 +41,8 @@ methods::setGeneric(
)

#' @param .full A [FAERSascii] object with data from full data. In this way,
#' `.object` must be a subset of `.full`. The unique number of primaryids will
#' be regarded as `n`.
#' `.object` must be a subset of `.full`. The unique number of `primaryids` from
#' `.full` will be regarded as `n`.
#' @inheritParams faers_counts
#' @export
#' @rdname faers_phv_signal
Expand Down Expand Up @@ -84,8 +83,8 @@ methods::setMethod(
)

#' @param .object2 A [FAERSascii] object with data from another interested drug,
#' In this way, `.object` and `.object2` should be not overlapped. The unique
#' number of primaryids will be regarded as `n0.`.
#' In this way, `.object` and `.object2` should not be overlapped. The unique
#' number of `primaryids` from `object2` will be regarded as `n0.`.
#' @rdname faers_phv_signal
#' @export
methods::setMethod(
Expand Down
4 changes: 2 additions & 2 deletions man/faers-package.Rd

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

13 changes: 6 additions & 7 deletions man/faers_phv_signal.Rd

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

0 comments on commit 9b88ea3

Please sign in to comment.