Skip to content

Commit 2dea907

Browse files
add URL vignette
1 parent 2384951 commit 2dea907

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

vignettes/runiverse.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Each universe has separate package list, so the user should specify the relevant
2525
wood_runiverse_packages(universe = "turtletopia")
2626
```
2727

28-
## Available package versions
28+
## Available package version
2929

3030
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()`.
3131

vignettes/url.Rmd

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "Analysing any URL"
3+
output: rmarkdown::html_vignette
4+
vignette: >
5+
%\VignetteIndexEntry{Analysing any URL}
6+
%\VignetteEngine{knitr::rmarkdown}
7+
%\VignetteEncoding{UTF-8}
8+
---
9+
10+
```{r, include = FALSE}
11+
knitr::opts_chunk$set(
12+
collapse = TRUE,
13+
comment = "#>"
14+
)
15+
library(woodendesc)
16+
```
17+
18+
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.
19+
20+
## Packages
21+
22+
To list all available packages the user should use `wood_url_packages()`.
23+
24+
```{r packages, cache=TRUE}
25+
wood_url_packages("https://colinfay.me")
26+
```
27+
28+
## Available package version
29+
30+
The structure of `PACKAGES` file allows only one version to be stored, so `wood_url_version()` may only return this one version.
31+
32+
```{r version, cache=TRUE}
33+
wood_url_version("dockerfiler", repository = "https://colinfay.me")
34+
```
35+
36+
## Package dependencies
37+
38+
The `PACKAGES` file is supposed to contain dependency data as well.
39+
40+
```{r deps, cache=TRUE}
41+
wood_url_dependencies("tidystringdist", repository = "https://colinfay.me")
42+
```

0 commit comments

Comments
 (0)