Skip to content

Commit

Permalink
Make links more precise and avoid URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
arisp99 committed Jan 25, 2022
1 parent b6e0321 commit 2e95031
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 40 deletions.
2 changes: 1 addition & 1 deletion R/arrange_natural.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#' \href{https://en.wikipedia.org/wiki/Natural_sort_order}{natural sorting}
#' (sorting of strings with both letters and numerals). The underlying
#' implementation for natural sorting is based on the
#' \href{https://stringi.gagolewski.com/}{`stringi`} library.
#' [stringi][stringi::about_stringi] library.
#'
#' @param .data A data frame, data frame extension (e.g. a tibble), or a lazy
#' data frame (e.g. from dbplyr or dtplyr).
Expand Down
4 changes: 2 additions & 2 deletions R/mutation-frequency.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ new_mut_freq <- function(x) {
#' filtered out from the analysis.
#'
#' @return
#' A [tibble][tibble::tibble()] with the extra class `mut_freq`. The output has
#' the following columns:
#' A [tibble][tibble::tibble-package] with the extra class `mut_freq`. The
#' output has the following columns:
#'
#' * `mutation_name`: The unique mutation sequenced.
#' * `frequency`: The frequency of the mutation.
Expand Down
4 changes: 2 additions & 2 deletions R/mutation-prevalence.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ new_mut_prev <- function(x) {
#' filtered out from the analysis.
#'
#' @return
#' A [tibble][tibble::tibble()] with the extra class `mutation_prev`. The output
#' has the following columns:
#' A [tibble][tibble::tibble-package] with the extra class `mutation_prev`. The
#' output has the following columns:
#'
#' * `mutation_name`: The unique mutation sequenced.
#' * `n_total`: The number of samples for which a mutation site was sequenced.
Expand Down
20 changes: 10 additions & 10 deletions R/read-deprecated.R
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,23 @@
#' @param .ref_file File path to the reference table.
#' @param .alt_file File path to the alternate table.
#' @param .cov_file File path to the coverage table.
#' @param ...
#' <[`data-masking`](https://dplyr.tidyverse.org/reference/dplyr_data_masking.html)>
#' Expressions that return a logical value and are used to filter the data. If
#' multiple expressions are included, they are combined with the `&` operator.
#' Only rows for which all conditions evaluate to `TRUE` are kept.
#' @param ... [`data-masking`][dplyr::dplyr_data_masking] Expressions that
#' return a logical value and are used to filter the data. If multiple
#' expressions are included, they are combined with the `&` operator. Only
#' rows for which all conditions evaluate to `TRUE` are kept.
#' @param chrom `r lifecycle::badge("deprecated")`: The chromosome(s) to filter
#' to.
#' @param gene `r lifecycle::badge("deprecated")`: The gene(s) to filter to.
#' @param .file File path to a file.
#' @param .name The information contained in the specific file. For example
#' `"coverage"` or `"ref_umi_count"`.
#'
#' @return A [`tibble()`][tibble::tibble()]. The first six columns contain the
#' metadata associated with each sample and mutation. Columns `ref_umi_count`
#' and `alt_umi_count` contain the umi count of the reference and alternate
#' allele, respectively. Column `coverage` contains the coverage for each data
#' point.
#' @return
#' A [`tibble()`][tibble::tibble-package]. The first six columns contain the
#' metadata associated with each sample and mutation. Columns `ref_umi_count`
#' and `alt_umi_count` contain the umi count of the reference and alternate
#' allele, respectively. Column `coverage` contains the coverage for each data
#' point.
#'
#' @seealso [vroom::vroom()] [dplyr::filter()]
#' @keywords internal
Expand Down
20 changes: 10 additions & 10 deletions R/read-tbl.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,10 @@
#' * [`between()`][dplyr::between()], [`near()`][dplyr::near()]
#'
#' @param .tbl File path to the table.
#' @param ...
#' <[`data-masking`](https://dplyr.tidyverse.org/reference/dplyr_data_masking.html)>
#' Expressions that return a logical value and are used to filter the data. If
#' multiple expressions are included, they are combined with the `&` operator.
#' Only rows for which all conditions evaluate to `TRUE` are kept.
#' @param ... [`data-masking`][dplyr::dplyr_data_masking] Expressions that
#' return a logical value and are used to filter the data. If multiple
#' expressions are included, they are combined with the `&` operator. Only
#' rows for which all conditions evaluate to `TRUE` are kept.
#' @param .col_select One or more selection expressions, like in
#' [`dplyr::select()`][dplyr::select()]. Use `c()` or `list()` to use more
#' than one expression. See [`?dplyr::select`][dplyr::select()] for details on
Expand All @@ -46,11 +45,12 @@
#' to.
#' @param gene `r lifecycle::badge("deprecated")` The gene(s) to filter to.
#'
#' @return A [`tibble()`][tibble::tibble()]. The first six columns contain the
#' metadata associated with each sample and mutation. The last column contains
#' the information parsed from the table. In some cases, this may be the
#' umi_count and in other cases it may be the coverage of the associated data
#' point.
#' @return
#' A [`tibble()`][tibble::tibble-package]. The first six columns contain the
#' metadata associated with each sample and mutation. The last column contains
#' the information parsed from the table. In some cases, this may be the
#' umi_count and in other cases it may be the coverage of the associated data
#' point.
#'
#' @seealso [vroom::vroom()] [dplyr::filter()]
#' @name read-tbl
Expand Down
2 changes: 1 addition & 1 deletion man/arrange_natural.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/mutation_frequency.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/mutation_prevalence.Rd

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

10 changes: 5 additions & 5 deletions man/read-deprecated.Rd

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

10 changes: 5 additions & 5 deletions man/read-tbl.Rd

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

0 comments on commit 2e95031

Please sign in to comment.