Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cansavvy committed Sep 19, 2024
1 parent 5cbe832 commit 91fd042
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 5 deletions.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Imports:
rprojroot,
ggplot2,
magick,
png,
Suggests:
knitr,
rmarkdown,
Expand Down
2 changes: 1 addition & 1 deletion R/setup_ids.R → R/generate_poster_ids.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions R/create_qr_codes.R → R/make_qr_code.R
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions man/generate_poster_ids.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion man/make_qr_code.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/make_random_ids.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 91fd042

Please sign in to comment.