Merge pull request #55 from EcologyR/prepareCRANupload

Prepare cran upload before examples
EcologyR · Jan 11, 2024 · 8bc9c88 · 8bc9c88
2 parents 5f5f8e0 + e8bb005
commit 8bc9c88
Show file tree

Hide file tree

Showing 46 changed files with 142 additions and 116 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -12,3 +12,4 @@
 output/
 
 
+^cran-comments\.md$
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@
 .httr-oauth
 .DS_Store
 output/
+labeleR_output
 
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,26 +1,27 @@
 Package: labeleR
 Title: Automate the Production of Custom Labels, Badges, Certificates, and Other Documents
-Version: 0.0.1
+Version: 0.1.0
 Authors@R: 
   c(
-  person("Ignacio", "Ramos-Gutiérrez",, "ig.ramosgutierrez@gmail.com", role = c("aut", "cre"),
+  person("Ignacio", "Ramos-Gutiérrez",, "ig.ramosgutierrez@gmail.com", role = c("aut", "cre", "cph"),
     comment = c(ORCID = "0000-0002-8675-0114")),
-  person("Julia G.", "de Aledo", , "juliagdealedo@gmail.com", role = "aut",
+  person("Julia G.", "de Aledo", , "juliagdealedo@gmail.com", role = c("aut", "cph"),
            comment = c(ORCID = "0000-0001-9065-9316")),
-  person("Francisco", "Rodríguez-Sánchez", , "frodriguez@us.es", role = "aut",
-           comment = c(ORCID = "0000-0002-7981-1599"))
+  person("Francisco", "Rodríguez-Sánchez", , "frodriguez@us.es", role = c("aut", "cph"),
+           comment = c(ORCID = "0000-0002-7981-1599")),
+  person("Giorgio", "Comai", role = "ctb")
   )
-Description: 'labeleR' makes it easy to create custom labels, badges, certificates
-  and other documents. It can be used to automate the production of potentially large 
+Description: Functions to create custom labels, badges, certificates
+  and other documents. Automate the production of potentially large 
   numbers of accreditation badges, attendance and participation certificates, 
   herbarium and collection labels, etc. Documents are generated in PDF format, 
   which requires a working installation of 'LaTeX', such as 'TinyTeX'.
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
-URL: https://github.com/EcologyR/labeleR
-BugReports: https://github.com/EcologyR/labeleR/issues
+URL: https://github.com/EcologyR/labeleR/
+BugReports: https://github.com/EcologyR/labeleR/issues/
 Depends: 
     R (>= 3.5.0)
 LazyData: true

diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
-YEAR: 2023
-COPYRIGHT HOLDER: templateRpackage authors
+YEAR: 2024
+COPYRIGHT HOLDER: labeleR authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2023 templateRpackage authors
+Copyright (c) 20234 labeleR authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,3 @@
-# templateRpackage 0.0.0.9000
+# labeleR 0.1.0
 
-* Added a `NEWS.md` file to track changes to the package.
+* First release
diff --git a/R/badge.R b/R/badge.R
@@ -11,13 +11,13 @@
 #' storing participants' affiliation.
 #' @param lpic Character (optional) Path to a PNG image to be located in the badge top-left.
 #' @param rpic Character (optional) Path to a PNG image to be located in the badge top-right.
-#' @param keep.files Logical. Keep the Rmarkdown template and associated files
+#' @param keep.files Logical. Keep the RMarkdown template and associated files
 #' in the output folder? Default is FALSE.
-#' @param template Character (optional) Rmarkdown template to use. If not provided,
+#' @param template Character (optional) RMarkdown template to use. If not provided,
 #' using the default template included in `labeleR`.
 #'
 #' @return A PDF file named "Badges.pdf" is saved on disk, in the folder defined
-#' by `path`. If `keep.files = TRUE`, an Rmarkdown and PNG lpic and rpic files will also
+#' by `path`. If `keep.files = TRUE`, an RMarkdown and PNG lpic and rpic files will also
 #' appear in the same folder.
 #'
 #' @export

diff --git a/R/certificate_attendance.R b/R/certificate_attendance.R
@@ -19,13 +19,13 @@
 #' the bottom, above signer's name.
 #' @param lpic Character (optional). Path to a PNG image to appear in the top-left.
 #' @param rpic Character (optional). Path to a PNG image to appear in the top-right.
-#' @param keep.files Logical. Keep the Rmarkdown template and associated files
+#' @param keep.files Logical. Keep the RMarkdown template and associated files
 #' in the output folder? Default is FALSE.
-#' @param template Character (optional) Rmarkdown template to use. If not provided,
+#' @param template Character (optional) RMarkdown template to use. If not provided,
 #' using the default template included in `labeleR`.
 #'
 #' @return PDF certificates are saved on disk, in the folder defined
-#' by `path`. If `keep.files = TRUE`, the Rmarkdown template and PNG logo files
+#' by `path`. If `keep.files = TRUE`, the RMarkdown template and PNG logo files
 #' will also appear in the same folder.
 #'
 #' @export

diff --git a/R/certificate_participation.R b/R/certificate_participation.R
@@ -25,13 +25,13 @@
 #' the bottom, above signer's name.
 #' @param lpic Character (optional) Path to a PNG image to appear in the top-left.
 #' @param rpic Character (optional) Path to a PNG image to appear in the top-right.
-#' @param keep.files Logical. Keep the Rmarkdown template and associated files
+#' @param keep.files Logical. Keep the RMarkdown template and associated files
 #' in the output folder? Default is FALSE.
-#' @param template Character (optional) Rmarkdown template to use. If not provided,
+#' @param template Character (optional) RMarkdown template to use. If not provided,
 #' using the default template included in `labeleR`.
 #'
 #' @return PDF certificates are saved on disk, in the folder defined
-#' by `path`. If `keep.files = TRUE`, the Rmarkdown template and PNG logo files
+#' by `path`. If `keep.files = TRUE`, the RMarkdown template and PNG logo files
 #' will also appear in the same folder.
 #'
 #' @export

diff --git a/R/collection_label.R b/R/collection_label.R
@@ -24,7 +24,7 @@
 #' @inheritParams create_badge
 #'
 #' @return A PDF file named "Collection_label.pdf" is saved on disk, in the folder defined
-#' by `path`. If `keep.files = TRUE`, an Rmarkdown and PNG logo files will also
+#' by `path`. If `keep.files = TRUE`, an RMarkdown and PNG logo files will also
 #' appear in the same folder.
 #'
 #' @export

diff --git a/R/tiny_label.R b/R/tiny_label.R
@@ -21,7 +21,7 @@
 #' @inheritParams create_badge
 #'
 #' @return A PDF file named "Tiny_label.pdf" is saved on disk, in the folder defined
-#' by `path`. If `keep.files = TRUE`, an Rmarkdown file will also appear in the same folder.
+#' by `path`. If `keep.files = TRUE`, an RMarkdown file will also appear in the same folder.
 #'
 #' @export
 #'

diff --git a/README.Rmd b/README.Rmd
@@ -23,8 +23,8 @@ knitr::opts_chunk$set(
 [![R-CMD-check](https://github.com/EcologyR/labeleR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/EcologyR/labeleR/actions/workflows/R-CMD-check.yaml)
 `r badger::badge_lifecycle("stable")`
 `r badger::badge_repostatus("Active")`
-[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square)](http://hits.dwyl.com/EcologyR/labeleR)
-[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square&show=unique)](http://hits.dwyl.com/EcologyR/labeleR)
+[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square)](https://hits.dwyl.com/EcologyR/labeleR)
+[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square&show=unique)](https://hits.dwyl.com/EcologyR/labeleR)
 <!-- badges: end -->
 
 <img src="man/figures/labeleR.png" width="140px" align="right"/>
@@ -106,7 +106,7 @@ which is the folder where the output PDFs will be stored. In case the
 specified folder does not exist, it will be automatically created. In
 case you want to name the output PDF file in a certain way, you must
 specify it using the `filename` argument. Additionally, you can store
-the created intermediate files (e.g. Rmarkdown, picture files) using
+the created intermediate files (e.g. RMarkdown, picture files) using
 `keep.files = TRUE`.
 
 Ultimately, labeleR uses its own templates to create the documents.
@@ -247,7 +247,7 @@ document.
 
 ### 2.3 Badges
 
-Badges (and all documents from now onwards) are rendered in a single
+Badges (and all documents from now onward) are rendered in a single
 document, with eight accreditation cards per DIN-A4 page in this case.
 They have only two variable fields (name and affiliation), and can
 include two top images, although are not signed. Accreditation cards
@@ -346,9 +346,9 @@ including a QR code (fixed or variable), a logo image. Field 1 will be
 capitalized (as in `family.column` in the herbarium label, and Field 2
 italicized). Any of the fields can be left blank.
 
-As a novelty, the user may manually fix the backgroud and text colours
-to their preference, using HTML colour codes (same code as HEX, but
-without the '\#'). By default, background colours are two hues of green.
+As a novelty, the user may manually fix the backgroud and text colors
+to their preference, using HTML color codes (same code as HEX, but
+without the '\#'). By default, background colors are two hues of green.
 
 +-----------------------------------------------------------------------+
 | ![Collection labels (blank)](man/figures/collection_labels_blank.png) |

diff --git a/README.md b/README.md
@@ -10,8 +10,8 @@
 [![Project Status: Active - The project has reached a stable, usable
 state and is being actively
 developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square)](http://hits.dwyl.com/EcologyR/labeleR)
-[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square&show=unique)](http://hits.dwyl.com/EcologyR/labeleR)
+[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square)](https://hits.dwyl.com/EcologyR/labeleR)
+[![HitCount](https://hits.dwyl.com/EcologyR/labeleR.svg?style=flat-square&show=unique)](https://hits.dwyl.com/EcologyR/labeleR)
 <!-- badges: end -->
 
 <img src="man/figures/labeleR.png" width="140px" align="right"/>
@@ -93,7 +93,7 @@ which is the folder where the output PDFs will be stored. In case the
 specified folder does not exist, it will be automatically created. In
 case you want to name the output PDF file in a certain way, you must
 specify it using the `filename` argument. Additionally, you can store
-the created intermediate files (e.g. Rmarkdown, picture files) using
+the created intermediate files (e.g. RMarkdown, picture files) using
 `keep.files = TRUE`.
 
 Ultimately, labeleR uses its own templates to create the documents.
@@ -227,7 +227,7 @@ document.
 
 ### 2.3 Badges
 
-Badges (and all documents from now onwards) are rendered in a single
+Badges (and all documents from now onward) are rendered in a single
 document, with eight accreditation cards per DIN-A4 page in this case.
 They have only two variable fields (name and affiliation), and can
 include two top images, although are not signed. Accreditation cards
@@ -325,9 +325,9 @@ including a QR code (fixed or variable), a logo image. Field 1 will be
 capitalized (as in `family.column` in the herbarium label, and Field 2
 italicized). Any of the fields can be left blank.
 
-As a novelty, the user may manually fix the backgroud and text colours
-to their preference, using HTML colour codes (same code as HEX, but
-without the ‘\#’). By default, background colours are two hues of green.
+As a novelty, the user may manually fix the backgroud and text colors to
+their preference, using HTML color codes (same code as HEX, but without
+the ‘\#’). By default, background colors are two hues of green.
 
 | ![Collection labels (blank)](man/figures/collection_labels_blank.png) |
 |-----------------------------------------------------------------------|
@@ -401,17 +401,19 @@ create_tinylabel(
 ## Citation
 
 
-    To cite labeleR in publications use:
+    To cite package 'labeleR' in publications use:
 
-      Ramos-Gutiérrez, I. G. de Aledo, J., Rodríguez-Sánchez, F. 2023.
-      labeleR.
+      Ramos-Gutierrez I, de Aledo JG, Rodríguez-Sánchez F (2023). _labeleR:
+      Automate the Production of Custom Labels, Badges, Certificates, and
+      Other Documents_. <https://EcologyR.github.io/labeleR/>.
 
     A BibTeX entry for LaTeX users is
 
       @Manual{,
-        title = {LabeleR},
+        title = {labeleR: Automate the Production of Custom Labels, Badges, Certificates, and Other Documents},
         author = {Ignacio Ramos-Gutierrez and Julia G. {de Aledo} and Francisco Rodríguez-Sánchez},
         year = {2023},
+        url = {https://EcologyR.github.io/labeleR/},
       }
 
 ## Funding

diff --git a/cran-comments.md b/cran-comments.md
@@ -0,0 +1,5 @@
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.
diff --git a/data/badges.table.rda b/data/badges.table.rda
diff --git a/data/participation.table.rda b/data/participation.table.rda
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/authors.html b/docs/authors.html