Skip to contents

Deploy a pkgdown website to AWS S3 bucket

Usage

pkgdownDeployToAws(
  package = getwd(),
  bucketDir = "s3://r.acidgenomics.com/packages/",
  clean = TRUE
)

Arguments

package

character. Directory path to R package. Parameterized, supporting building of multiple package websites in a single call.

bucketDir

character(1). Unused. Retained for backward compatibility only.

clean

logical(1). Unused. Retained for backward compatibility only.

Value

logical. Whether individual pkgdown builds were successful, corresponding to input defined in package argument.

Details

Deprecated in favor of koopa app r publish-docs, which builds the pkgdown site and syncs it to the account-scoped R bucket resolved via koopa_s3_bucket("r"), serving docs at https://r.acidgenomics.com/<name>/. The old default bucketDir here pointed at the legacy s3://r.acidgenomics.com/packages/ bucket, which is no longer the live origin for r.acidgenomics.com and was never actually being read by visitors to the site.

Note

Updated 2026-07-28.

Examples

## > pkgdownDeployToAws(
## >     package = file.path("~", "monorepo", "r-packages", "r-koopa")
## > )