Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
deeenes committed Apr 13, 2024
1 parent c379027 commit 83cb658
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions R/evidences.R
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ unnest_evidences <- function(data, longer = FALSE, .keep = FALSE) {
#' and "undirected" are filtered, if present.
#' @param datasets A character vector of dataset names.
#' @param resources A character vector of resource names.
#' @param exclude Character vector of resource names to be excluded.
#'
#' @return The input data frame with the evidences in the selected columns
#' filtered.
Expand Down Expand Up @@ -218,6 +219,7 @@ filter_evidences <- function(
#'
#' @param lst A list extracted from the JSON "evidences" column returned by
#' OmniPath interactions queries.
#' @param exclude Character vector of resource names to be excluded.
#'
#' @importFrom magrittr %>% is_in not
#' @importFrom purrr map2 keep map
Expand Down Expand Up @@ -262,6 +264,7 @@ filter_evs_lst <- function(
#'
#' @param ev An evidence data structure, which is a nested list, as it is
#' extracted from the JSON in the "evidences" column from OmniPath queries.
#' @param exclude Character vector of resource names to be excluded.
#'
#' @importFrom magrittr %>%
#' @noRd
Expand Down Expand Up @@ -296,6 +299,7 @@ match_evidence <- function(
#' these datasets will be used.
#' @param resources Character: a vector of resource labels. Only evidences
#' from these resources will be used.
#' @param exclude Character vector of resource names to be excluded.
#' @param .keep Logical: keep the "evidences" column.
#'
#' @return A copy of the interaction data frame restricted to the given
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/filter_evidences.html

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

4 changes: 4 additions & 0 deletions docs/reference/only_from.html

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

2 changes: 2 additions & 0 deletions man/filter_evidences.Rd

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

2 changes: 2 additions & 0 deletions man/only_from.Rd

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

0 comments on commit 83cb658

Please sign in to comment.