Skip to content

Commit

Permalink
add URL vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
ErdaradunGaztea committed Jan 26, 2025
1 parent 2384951 commit 2dea907
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
2 changes: 1 addition & 1 deletion vignettes/runiverse.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Each universe has separate package list, so the user should specify the relevant
wood_runiverse_packages(universe = "turtletopia")
```

## Available package versions
## Available package version

Since R-universe works by pointing to the latest commit on the main branch, there's always one version of a package; to extract it the user should use `wood_runiverse_version()`.

Expand Down
42 changes: 42 additions & 0 deletions vignettes/url.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "Analysing any URL"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Analysing any URL}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
library(woodendesc)
```

Other than all the explicitly supported repositories (CRAN, Bioconductor, etc.), locally set up repositories can also be analysed using {woodendesc}. The requirement is they must contain the `PACKAGES` file (or `PACKAGES.gz`, its compressed counterpart) under `/src/contrib` path; the file should effectively be a concatenation of relevant attributes from all `DESCRIPTION` files of the packages the repository contains.

## Packages

To list all available packages the user should use `wood_url_packages()`.

```{r packages, cache=TRUE}
wood_url_packages("https://colinfay.me")
```

## Available package version

The structure of `PACKAGES` file allows only one version to be stored, so `wood_url_version()` may only return this one version.

```{r version, cache=TRUE}
wood_url_version("dockerfiler", repository = "https://colinfay.me")
```

## Package dependencies

The `PACKAGES` file is supposed to contain dependency data as well.

```{r deps, cache=TRUE}
wood_url_dependencies("tidystringdist", repository = "https://colinfay.me")
```

0 comments on commit 2dea907

Please sign in to comment.