This PR cleans up the docs in a way to make them simpler to ingest by
our [docs repo](https://gitea.com/gitea/gitea-docusaurus).

1. It includes all of the sed invocations our ingestion did, removing
the need to do it at build time.
2. It replaces the shortcode variable replacement method with
`@variable@` style, simply for easier sed invocations when required.
3. It removes unused files and moves the docs up a level as cleanup.

---------

Signed-off-by: jolheiser <john.olheiser@gmail.com>

2023-07-26 04:53:13 +00:00

2.2 KiB

Raw Blame History

date

title

slug

draft

toc

2023-01-01T00:00:00+00:00

CRAN Package Registry

cran

false

sidebar

parent	name	sidebar_position	identifier
packages	CRAN	35	cran

CRAN Package Registry

Publish R packages to a CRAN-like registry for your user or organization.

Requirements

To work with the CRAN package registry, you need to install R.

Configuring the package registry

To register the package registry you need to add it to Rprofile.site, either on the system-level, user-level (~/.Rprofile) or project-level:

options("repos" = c(getOption("repos"), c(gitea="https://gitea.example.com/api/packages/{owner}/cran")))

Parameter	Description
`owner`	The owner of the package.

If you need to provide credentials, you may embed them as part of the url (https://user:password@gitea.example.com/...).

Publish a package

To publish a R package, perform a HTTP PUT operation with the package content in the request body.

Source packages:

PUT https://gitea.example.com/api/packages/{owner}/cran/src

Parameter	Description
`owner`	The owner of the package.

Binary packages:

PUT https://gitea.example.com/api/packages/{owner}/cran/bin?platform={platform}&rversion={rversion}

Parameter	Description
`owner`	The owner of the package.
`platform`	The name of the platform.
`rversion`	The R version of the binary.

For example:

curl --user your_username:your_password_or_token \
     --upload-file path/to/package.zip \
     https://gitea.example.com/api/packages/testuser/cran/bin?platform=windows&rversion=4.2

You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.

Install a package

To install a R package from the package registry, execute the following command:

install.packages("{package_name}")

Parameter	Description
`package_name`	The package name.

For example:

install.packages("testpackage")

2.2 KiB Raw Blame History

CRAN Package Registry

Requirements

Configuring the package registry

Publish a package

Install a package

2.2 KiB

Raw Blame History