Skip to content

Commit

Permalink
Merge pull request #58 from EcologyR/function_names
Browse files Browse the repository at this point in the history
functions names changed to tiny_label and certificate atr end
  • Loading branch information
iramosgutierrez committed Jan 16, 2024
2 parents f4dc8a2 + d0bf2e7 commit 48fb1b1
Show file tree
Hide file tree
Showing 19 changed files with 1,208 additions and 37 deletions.
6 changes: 3 additions & 3 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Generated by roxygen2: do not edit by hand

export(create_attendance_certificate)
export(create_badge)
export(create_certificate_attendance)
export(create_certificate_participation)
export(create_collection_label)
export(create_herbarium_label)
export(create_tinylabel)
export(create_participation_certificate)
export(create_tiny_label)
4 changes: 2 additions & 2 deletions R/certificate_attendance.R
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
#'
#' @examplesIf interactive()
#'
#' create_certificate_attendance(
#' create_attendance_certificate(
#' data = attendance.table,
#' path = "labeleR_output",
#' language = "English",
Expand All @@ -52,7 +52,7 @@
#' )


create_certificate_attendance <- function(
create_attendance_certificate <- function(
data = NULL,
path = NULL,
filename = NULL,
Expand Down
4 changes: 2 additions & 2 deletions R/certificate_participation.R
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
#'
#' @examplesIf interactive()
#
#' create_certificate_participation(
#' create_participation_certificate(
#' data = participation.table,
#' path = "labeleR_output",
#' language = "Spanish",
Expand All @@ -59,7 +59,7 @@
#' signature.pic = NULL
#' )

create_certificate_participation <- function(
create_participation_certificate <- function(
data = NULL,
path = NULL,
filename = NULL,
Expand Down
4 changes: 2 additions & 2 deletions R/tiny_label.R
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#' @author Ignacio Ramos-Gutierrez, Julia G. de Aledo, Francisco Rodriguez-Sanchez
#'
#' @examplesIf interactive()
#' create_tinylabel(
#' create_tiny_label(
#' data = tiny.table,
#' qr = "QR_code",
#' path = "labeleR_output",
Expand All @@ -40,7 +40,7 @@
#' )
#'

create_tinylabel <- function(data = NULL,
create_tiny_label <- function(data = NULL,
qr = NULL,
path = NULL,
filename = NULL,
Expand Down
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ information is stored, two-word parameters are used (i.e. `name.column`
or `species.column`). The only parameter that does not follow this
philosophy is `qr` in the functions that allow to plot them (i.e.
`create_herbarium_label`, `create_collection_label` and
`create_tinylabel`). This parameter can be set as a column name, which
`create_tiny_label`). This parameter can be set as a column name, which
will result in variable parameter, or as a free text (not column name),
which will be used as a fixed one.

Expand Down Expand Up @@ -167,7 +167,7 @@ of Hogwarts School, in which the Headmaster certifies they have attended

```{r create attendance certificates, eval=FALSE}
create_certificate_attendance(
create_attendance_certificate(
data = attendance.table,
path = "labeleR_output",
filename = "attendance_certificates",
Expand Down Expand Up @@ -214,7 +214,7 @@ participated in some seminars with different titles, different
affiliations, dates and communication types.

```{r create participation certificates, eval=FALSE}
create_certificate_participation(
create_participation_certificate(
data = participation.table,
path = "labeleR_output",
filename = "participation_certificates",
Expand Down Expand Up @@ -405,7 +405,7 @@ Here, tinylabels are created for typical collections stored in boxes, so
a normal collection label would be to big.

```{r tinylabels, eval=FALSE}
create_tinylabel(
create_tiny_label(
data = tiny.table,
qr="QR_code",
path = "labeleR_output",
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ of Hogwarts School, in which the Headmaster certifies they have attended

``` r

create_certificate_attendance(
create_attendance_certificate(
data = attendance.table,
path = "labeleR_output",
filename = "attendance_certificates",
Expand Down Expand Up @@ -197,7 +197,7 @@ participated in some seminars with different titles, different
affiliations, dates and communication types.

``` r
create_certificate_participation(
create_participation_certificate(
data = participation.table,
path = "labeleR_output",
filename = "participation_certificates",
Expand Down
7 changes: 4 additions & 3 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ url: https://ecologyr.github.io/labeleR/
reference:
- title: Functions
contents:
- create_certificate_attendance
- create_certificate_participation
- create_attendance_certificate
- create_participation_certificate
- create_badge
- create_herbarium_label
- create_collection_label
- create_tinylabel
- create_tiny_label

- title: Example datasets
contents:
- attendance.table
Expand Down
480 changes: 480 additions & 0 deletions docs/index.html

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions docs/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pandoc: 2.19.2
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
last_built: 2024-01-12T14:30Z

210 changes: 210 additions & 0 deletions docs/reference/create_attendance_certificate.html

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

Loading

0 comments on commit 48fb1b1

Please sign in to comment.