Skip to content

Commit

Permalink
fixed links to lookup repo
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno Rodrigues committed Sep 11, 2023
1 parent 506784b commit b8c1424
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 13 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Suggests:
testthat
VignetteBuilder:
knitr
Config/fusen/version: 0.5.2
Config/fusen/version: 0.5.1
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
Expand Down
15 changes: 9 additions & 6 deletions dev/pkgs_with_remotes.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,15 @@ vignette explains how to install such a packages with dependencies on Github.

## The {lookup} package

As an example we are going to use the `{lookup}` package which has only been
As an example we are going to use the
[{lookup}](https://github.com/jimhester/lookup) package which has only been
released on Github. [Here is the
repository](https://github.com/jimhester/lookup). This package comes with the
`lookup()` function which makes it possible to check the source code of any
function from a loaded package, even if the source of that function is in C or
Fortran. To create a reproducible development environment that makes `{lookup}`
available to you, you could use the following `rix::rix()` call:
Fortran. To create a reproducible development environment that makes
[{lookup}](https://github.com/jimhester/lookup) available to you, you could use
the following `rix::rix()` call:

```{r}
path_default_nix <- tempdir()
Expand All @@ -52,8 +54,9 @@ error: attribute 'highlite' missing

## Building remote dependencies

`{highlite}` is a dependency of `{lookup}` that is only available on CRAN. This
can be checked by looking at the `DESCRIPTION` file of `{lookup}`:
`{highlite}` is a dependency of [{lookup}](https://github.com/jimhester/lookup)
that is only available on CRAN. This can be checked by looking at the
`DESCRIPTION` file of [{lookup}](https://github.com/jimhester/lookup):

```
Remotes:
Expand Down Expand Up @@ -168,7 +171,7 @@ make `{rix}` handle remote dependencies automatically. This is for mainly three
reasons:

- packages with remote dependencies are rare, and never on CRAN on Bioconductor;
- packages may have remote dependencies, but these dependencies may later be available on CRAN (such as with `{memoise}` and `{gh}` for `{lookup}`);
- packages may have remote dependencies, but these dependencies may later be available on CRAN (such as with `{memoise}` and `{gh}` for [{lookup}](https://github.com/jimhester/lookup));
- `{rix}` cannot decide for the user which commit to use for a remote dependency (or whether to use the released version of that dependency from CRAN).

Because of these reasons, we believe that it is safer for users that really need
Expand Down
15 changes: 9 additions & 6 deletions vignettes/handling-packages-with-remote-dependencies.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,15 @@ vignette explains how to install such a packages with dependencies on Github.

## The {lookup} package

As an example we are going to use the `{lookup}` package which has only been
As an example we are going to use the
[{lookup}](https://github.com/jimhester/lookup) package which has only been
released on Github. [Here is the
repository](https://github.com/jimhester/lookup). This package comes with the
`lookup()` function which makes it possible to check the source code of any
function from a loaded package, even if the source of that function is in C or
Fortran. To create a reproducible development environment that makes `{lookup}`
available to you, you could use the following `rix::rix()` call:
Fortran. To create a reproducible development environment that makes
[{lookup}](https://github.com/jimhester/lookup) available to you, you could use
the following `rix::rix()` call:


```{r}
Expand Down Expand Up @@ -70,8 +72,9 @@ error: attribute 'highlite' missing

## Building remote dependencies

`{highlite}` is a dependency of `{lookup}` that is only available on CRAN. This
can be checked by looking at the `DESCRIPTION` file of `{lookup}`:
`{highlite}` is a dependency of [{lookup}](https://github.com/jimhester/lookup)
that is only available on CRAN. This can be checked by looking at the
`DESCRIPTION` file of [{lookup}](https://github.com/jimhester/lookup):

```
Remotes:
Expand Down Expand Up @@ -186,7 +189,7 @@ make `{rix}` handle remote dependencies automatically. This is for mainly three
reasons:

- packages with remote dependencies are rare, and never on CRAN on Bioconductor;
- packages may have remote dependencies, but these dependencies may later be available on CRAN (such as with `{memoise}` and `{gh}` for `{lookup}`);
- packages may have remote dependencies, but these dependencies may later be available on CRAN (such as with `{memoise}` and `{gh}` for [{lookup}](https://github.com/jimhester/lookup));
- `{rix}` cannot decide for the user which commit to use for a remote dependency (or whether to use the released version of that dependency from CRAN).

Because of these reasons, we believe that it is safer for users that really need
Expand Down

0 comments on commit b8c1424

Please sign in to comment.