diff --git a/DESCRIPTION b/DESCRIPTION index a925ca3..3d9b425 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -24,6 +24,7 @@ Imports: rprojroot, ggplot2, magick, + png, Suggests: knitr, rmarkdown, diff --git a/R/setup_ids.R b/R/generate_poster_ids.R similarity index 98% rename from R/setup_ids.R rename to R/generate_poster_ids.R index b15dcc4..b06fb92 100644 --- a/R/setup_ids.R +++ b/R/generate_poster_ids.R @@ -15,7 +15,7 @@ make_random_ids <- function(n = 1, seed = 1234) { #' Generate poster ids #' @description Given a poster googlesheet with the columns `poster_title` and `presenter_name` this function will create a new sheet that has a column with unique poster ids #' @param prefill_url Go to your form, click on the vertical "..." to see more options in the right corner. Click "get prefill link". -#' Put in the poster id and poster name responses {poster_id} and {poster_name} respectively +#' Put in the poster id and poster name responses `{poster_id}` and `{poster_name}` respectively #' @param poster_googlesheet A link to a googlesheet that contains at least two column names that are `poster_title` and `presenter_name` #' @param dest_folder A character string of the folder where qr-codes should be saved. If the folder doesn't exist, one will be made with this name. Default is `qr-codes`. #' @param poster_id By default poster ids will be created. Alternatively you can use this argument to specify the column name of the existing IDs in the sheet you'd like to use. diff --git a/R/create_qr_codes.R b/R/make_qr_code.R similarity index 78% rename from R/create_qr_codes.R rename to R/make_qr_code.R index e5e2ffc..370fbc6 100644 --- a/R/create_qr_codes.R +++ b/R/make_qr_code.R @@ -1,6 +1,9 @@ #' Make QR code for a poster #' @description This returns a random jumble of letters and numbers that are used as poster ids +#' @param prefill_url Go to your form, click on the vertical "..." to see more options in the right corner. Click "get prefill link". +#' Put in the poster id and poster name responses `{poster_id}` and `{poster_name}` respectively +#' @param dest_folder A character string of the folder where qr-codes should be saved. If the folder doesn't exist, one will be made with this name. Default is `qr-codes`. #' @param poster_id The associated id for the poster #' @param poster_title The title for the poster #' @param presenter_name The presenter of the poster diff --git a/man/generate_poster_ids.Rd b/man/generate_poster_ids.Rd index de5936a..23ea6f1 100644 --- a/man/generate_poster_ids.Rd +++ b/man/generate_poster_ids.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/setup_ids.R +% Please edit documentation in R/generate_poster_ids.R \name{generate_poster_ids} \alias{generate_poster_ids} \title{Generate poster ids} @@ -14,7 +14,7 @@ generate_poster_ids( } \arguments{ \item{prefill_url}{Go to your form, click on the vertical "..." to see more options in the right corner. Click "get prefill link". -Put in the poster id and poster name responses {poster_id} and {poster_name} respectively} +Put in the poster id and poster name responses `{poster_id}` and `{poster_name}` respectively} \item{poster_googlesheet}{A link to a googlesheet that contains at least two column names that are `poster_title` and `presenter_name`} diff --git a/man/make_qr_code.Rd b/man/make_qr_code.Rd index 75878f8..2892318 100644 --- a/man/make_qr_code.Rd +++ b/man/make_qr_code.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/create_qr_codes.R +% Please edit documentation in R/make_qr_code.R \name{make_qr_code} \alias{make_qr_code} \title{Make QR code for a poster} @@ -7,11 +7,16 @@ make_qr_code(prefill_url, poster_id, poster_title, presenter_name, dest_folder) } \arguments{ +\item{prefill_url}{Go to your form, click on the vertical "..." to see more options in the right corner. Click "get prefill link". +Put in the poster id and poster name responses `{poster_id}` and `{poster_name}` respectively} + \item{poster_id}{The associated id for the poster} \item{poster_title}{The title for the poster} \item{presenter_name}{The presenter of the poster} + +\item{dest_folder}{A character string of the folder where qr-codes should be saved. If the folder doesn't exist, one will be made with this name. Default is `qr-codes`.} } \value{ This function returns a list from a API response JSON file diff --git a/man/make_random_ids.Rd b/man/make_random_ids.Rd index 3edfb41..324433d 100644 --- a/man/make_random_ids.Rd +++ b/man/make_random_ids.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/setup_ids.R +% Please edit documentation in R/generate_poster_ids.R \name{make_random_ids} \alias{make_random_ids} \title{Make a random id}