From d413c94a29aff4a72569b08e2105017e6bc76724 Mon Sep 17 00:00:00 2001 From: maelle Date: Thu, 12 Dec 2024 13:27:55 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20r-univer?= =?UTF-8?q?se-org/docs@7a6f84a3ca0afb2e7ef0aabbc57b1681b533f638=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- browse/api.html | 18 +- browse/get-started.html | 18 +- browse/packages.html | 19 +- browse/rss-feeds.html | 18 +- browse/search.html | 18 +- browse/universes.html | 18 +- index.html | 18 +- install/binaries.html | 18 +- install/dependencies.html | 773 -------------------------------- install/reproducibility.html | 24 +- publish/get-started.html | 64 ++- publish/metadata.html | 78 ++-- publish/other-networks.html | 46 +- publish/set-up.html | 106 +++-- publish/terms.html | 48 +- publish/troubleshoot-build.html | 65 ++- search.json | 252 +++++------ sitemap.xml | 34 +- 18 files changed, 376 insertions(+), 1259 deletions(-) delete mode 100644 install/dependencies.html diff --git a/browse/api.html b/browse/api.html index 75a5c43..cdcf820 100644 --- a/browse/api.html +++ b/browse/api.html @@ -222,12 +222,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -243,37 +237,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • diff --git a/browse/get-started.html b/browse/get-started.html index 973650b..e97f163 100644 --- a/browse/get-started.html +++ b/browse/get-started.html @@ -188,12 +188,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -209,37 +203,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • diff --git a/browse/packages.html b/browse/packages.html index 9cb51a0..b2fbdc8 100644 --- a/browse/packages.html +++ b/browse/packages.html @@ -225,12 +225,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -246,37 +240,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • @@ -379,6 +373,7 @@

    ## 4 libstdc++.so.6.0.28 libstdc++6 <NA> gcc 10-20200411-0ubuntu1

    In a nutshell, maketools calls ldd on the installed R package to see which .so files are linked (the 1st column above). Then it uses the distro package manager (for instance dpkg) to query the runtime package deb that provides this file (the second column), and the corresponding headers and source packages. So to emphasize, this does not use heuristics / guessing based on the package description.

    The maketools vignette explains this in more detail: Automatically determine run-time dependencies for R packages on Linux.

    +

    See also how to request a third-party system that your package needs.

    diff --git a/browse/rss-feeds.html b/browse/rss-feeds.html index 2fbc9f8..1851061 100644 --- a/browse/rss-feeds.html +++ b/browse/rss-feeds.html @@ -188,12 +188,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -209,37 +203,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • diff --git a/browse/search.html b/browse/search.html index 7cceacd..4220c6a 100644 --- a/browse/search.html +++ b/browse/search.html @@ -191,12 +191,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -212,37 +206,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • diff --git a/browse/universes.html b/browse/universes.html index e92eaa3..adab562 100644 --- a/browse/universes.html +++ b/browse/universes.html @@ -225,12 +225,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -246,37 +240,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • diff --git a/index.html b/index.html index 4a7933c..c250f7c 100644 --- a/index.html +++ b/index.html @@ -187,12 +187,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -208,37 +202,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • diff --git a/install/binaries.html b/install/binaries.html index b0ed86a..859c2cb 100644 --- a/install/binaries.html +++ b/install/binaries.html @@ -222,12 +222,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -243,37 +237,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • diff --git a/install/dependencies.html b/install/dependencies.html deleted file mode 100644 index 83989fa..0000000 --- a/install/dependencies.html +++ /dev/null @@ -1,773 +0,0 @@ - - - - - - - - - -10  Using dependencies from R-universe – R-Universe Docs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - -
    - -
    - - -
    - - - -
    - -
    -
    -

    10  Using dependencies from R-universe

    -
    - - - -
    - - - - -
    - - - -
    - - -
    -

    10.1 Can a CRAN package take on a dependency from R-universe?

    -

    Yes! It has to be an optional dependency (Suggests) and you need to

    -
      -

    • List the R-universe in the Additional_repositories field in DESCRIPTION. Examples of CRAN packages doing so. The field will not ensure installation of the package. Its sole purpose is allowing CRAN to check the package is indeed available in that other repository.

      • -

    • Document, for the user, how to install the missing package. You can do that

      -
        -
      • In user-facing documentation (README, package-level manual page, manual page of the functions that use the dependency). Example.
        • -
      • Within the code, for instance:
        • -
      • -
    -
    rlang::check_installed("targets", action = function(...) install.packages('targets', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org')))
    -
    -
    -

    10.2 How to use a universe on regular continous integration?

    -

    If you want to test a package against versions of other packages that are in a universe, on GitHub Actions you can use the extra-repositories field of the r-lib/actions setup-r action.

    - - -
    - -
    - - -
    - - - - - \ No newline at end of file diff --git a/install/reproducibility.html b/install/reproducibility.html index 8a57a28..2cfd4f2 100644 --- a/install/reproducibility.html +++ b/install/reproducibility.html @@ -64,7 +64,7 @@ - + @@ -222,12 +222,6 @@ 9  Reproducibility - -
  • -
    - - 10  Using dependencies from R-universe -
    • @@ -243,37 +237,37 @@
  • - 11  Why publish on R-universe + 10  Why publish on R-universe
  • - 12  Set up your own universe + 11  Set up your own universe
  • - 13  Make your package easier to discover: Control the metadata / SEO + 12  Make your package easier to discover: Control the metadata / SEO
  • - 14  Trouble shoot package builds + 13  Trouble shoot package builds
  • - 15  Package publishing rules + 14  Package publishing rules
  • - 16  Relation to other networks + 15  Relation to other networks
    • @@ -787,8 +781,8 @@

    - - 10  Using dependencies from R-universe + + 10  Why publish on R-universe
    diff --git a/publish/get-started.html b/publish/get-started.html index 37f51f6..7fbe8b4 100644 --- a/publish/get-started.html +++ b/publish/get-started.html @@ -7,7 +7,7 @@ -11  Why publish on R-universe – R-Universe Docs +10  Why publish on R-universe – R-Universe Docs