From 582190df6e2ca924fe8ed34a7458915eeafdd1be Mon Sep 17 00:00:00 2001 From: novica Date: Sat, 7 Nov 2026 18:17:40 +0100 Subject: [PATCH] chore: installation docs --- README.md | 12 ++++++------ vignettes/articles/lambda-s3.qmd | 4 ++-- vignettes/articles/tt-lambda.qmd | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 95fd11a..82d260c 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ coverage](https://codecov.io/gh/discindo/r2lambda/graph/badge.svg)](https://app.codecov.io/gh/discindo/r2lambda) -The goal of `{r2lambda}` is to make it easier to go from an `R` script +The goal of `r2lambda` is to make it easier to go from an `R` script to a deployed `AWS Lambda` function. ## System requirements -`{r2lambda}` calls two programs outside R. They are the same on Linux, +`r2lambda` calls two programs outside R. They are the same on Linux, macOS and Windows; only how you install them differs. - [Docker](https://docs.docker.com/get-docker/) with the @@ -30,17 +30,17 @@ macOS and Windows; only how you install them differs. ## Installation -You can install the released version of `{r2lambda}` from CRAN with: +You can install the released version of `r2lambda` from CRAN with: ``` r install.packages("r2lambda") ``` -You can install the development version of `{r2lambda}` from GitHub with: +You can install the development version of `r2lambda` from GitHub with: ``` r -# install.packages("remotes") -remotes::install_github("discindo/r2lambda") +# install.packages("pak") +pak::pak("discindo/ggindex") ``` ## Setup diff --git a/vignettes/articles/lambda-s3.qmd b/vignettes/articles/lambda-s3.qmd index 608842b..289258c 100644 --- a/vignettes/articles/lambda-s3.qmd +++ b/vignettes/articles/lambda-s3.qmd @@ -17,7 +17,7 @@ library(tidytuesdayR) At the end of this tutorial, we would have created an AWS Lambda function that fetches the most-recent Tidytuesday dataset and writes it into an S3 Bucket every Wednesday. -To do this, we'll first work interactively with `{r2lambda}` and `{paws}` to go +To do this, we'll first work interactively with `r2lambda` and `{paws}` to go through all the steps the Lambda function would eventually need to do, then wrap the code and deploy it to AWS Lambda, and finally schedule it to run weekly. @@ -33,7 +33,7 @@ session helps. **To run any of the code below, you need some environmental variables set. See the [Setup](https://github.com/discindo/r2lambda#build-a-docker-image-for-the-lambda-function) -section in the `{r2lambda}` package readme for more details** +section in the `r2lambda` package readme for more details** ```{r} s3_service <- aws_connect("s3") diff --git a/vignettes/articles/tt-lambda.qmd b/vignettes/articles/tt-lambda.qmd index a96f373..3b92cdc 100644 --- a/vignettes/articles/tt-lambda.qmd +++ b/vignettes/articles/tt-lambda.qmd @@ -12,7 +12,7 @@ knitr: library(r2lambda) ``` -## Use `{r2lambda}` to download Tidytuesday dataset +## Use `r2lambda` to download Tidytuesday dataset In this exercise, we'll create an AWS Lambda function that downloads the [tidytuesday](https://github.com/rfordatascience/tidytuesday) @@ -94,7 +94,7 @@ that calls `install.packages` to install `{tidytuesdayR}` from CRAN. - Finally, the `tag` argument sets the name of our Lambda function which we'll use later to test and invoke the function. The `tag` argument also becomes the name of -the folder that `{r2lambda}` will create to build the image. This folder will have +the folder that `r2lambda` will create to build the image. This folder will have two files, `Dockerfile` and `runtime.R`. `runtime.R` is our script from `runtime_path`, renamed before it is copied in the `docker` image with a `COPY` instruction.