Skip to content

Commit

Permalink
Update universes.qmd for enhanced clarity and structure (#54)
Browse files Browse the repository at this point in the history
* Update universes.qmd for enhanced clarity and structure

* fix typo

* rm horizontal lines

---------

Co-authored-by: Maëlle Salmon <[email protected]>
  • Loading branch information
YaoxiangLi and maelle authored Dec 9, 2024
1 parent 3f5a345 commit 1adafba
Showing 1 changed file with 28 additions and 11 deletions.
39 changes: 28 additions & 11 deletions browse/universes.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,42 @@ title: "Browsing work from a maintainer or organization"
Each user and organization in R-universe has a unique subdomain under r-universe.dev with a package repository from where packages can directly be installed.
For example, the packages and information from rOpenSci can be found on https://ropensci.r-universe.dev, and packages maintained by Jeroen Ooms are listed at https://jeroen.r-universe.dev (note how these two sets overlap).

The top tabs allow you to explore different resources within universe.
The top tabs allow you to explore different resources within universes.

![Builds tab of an universe](../img/univ-builds.png){group="univ" fig-alt="Builds tab of an universe, including a summary table of package versions and the status of latest builds on different OS."}
### Builds Tab

The builds tab shows the current state of the repository: a table with the name and version of each package, including the commit date, author, and build status.
Clicking on the package name in the table sends you to the [homepage of the package](/browse/packages.html), and the maintainer name links to the subdomain of that maintainer, listing other projects maintained by this person.
![Builds tab of a universe](../img/univ-builds.png){group="univ" fig-alt="Builds tab of a universe, including a summary table of package versions and the status of latest builds on different OS."}

![Packages tab of an universe](../img/univ-packages.png){group="univ" fig-alt="Packages tab of an universe, showing one summary card per package."}
The **Builds tab** shows the current state of the repository in a table, including:
- Package name and version,
- Commit date,
- Author, and
- Build status.

![Articles tab of an universe](../img/univ-articles.png){group="univ" fig-alt="Articles tab of an universe, showing all vignettes."}
Clicking on a package name takes you to its [homepage](/browse/packages.html), while clicking the maintainer’s name links to their subdomain, where you can explore other projects they maintain.

The packages tab lists descriptive information from all packages in the repository, and the articles tab shows all documents (e.g. vignettes).

![Contributors tab of an universe](../img/univ-contributors.png){group="univ" fig-alt="Contributors tab of an universe, showing contribution activity per contributor."}
### Packages and Articles Tabs

The contributors tab shows a chart with contributor statistics for the organization or maintainer.
Clicking on the a bar in the chart sends you to this other universe where you can explore more work by this person.
![Packages tab of a universe](../img/univ-packages.png){group="univ" fig-alt="Packages tab of a universe, showing one summary card per package."}

The same subdomain hosts the actual cran-like package repository for this user or organization. Hence in order to list or install packages from rOpenSci in R, you would use:
The **Packages tab** lists descriptive information for all packages in the repository.

![Articles tab of a universe](../img/univ-articles.png){group="univ" fig-alt="Articles tab of a universe, showing all vignettes."}

The **Articles tab** displays all documents (e.g., vignettes).

### Contributors Tab

![Contributors tab of a universe](../img/univ-contributors.png){group="univ" fig-alt="Contributors tab of a universe, showing contribution activity per contributor."}

The **Contributors tab** shows a chart with contributor statistics for the organization or maintainer.
Clicking a bar in the chart takes you to that contributor’s universe, where you can explore more of their work.

### Installing Packages from a Universe

Each subdomain also hosts a CRAN-like package repository for the user or organization.
To list or install packages from rOpenSci in R, you can use:

```r
# List available packages
Expand Down

0 comments on commit 1adafba

Please sign in to comment.