Type:	Package
Version:	0.2.5
Title:	Reproducible and Flexible Label Design
Description:	An open-source R package to deploys reproducible and flexible labels using layers. The 'huito' package is part of the 'inkaverse' project for developing different procedures and tools used in plant science and experimental designs. Learn more about the 'inkaverse' project at https://inkaverse.com/.
Date:	2024-09-04
URL:	https://huito.inkaverse.com/, https://github.com/flavjack/huito
BugReports:	https://github.com/flavjack/huito/issues/
Depends:	magick, cowplot, ggplot2, dplyr, R (≥ 2.10)
Imports:	tidyr, tibble, purrr, sysfonts, showtext, qrcode, pdftools
Suggests:	knitr, rmarkdown, bookdown, gsheet, inti
VignetteBuilder:	knitr
License:	GPL-3 | file LICENSE
Encoding:	UTF-8
RoxygenNote:	7.3.2
LazyData:	true
NeedsCompilation:	no
Packaged:	2024-09-05 03:29:59 UTC; floza
Author:	Flavio Lozano-Isla [aut, cre], Inkaverse [cph]
Maintainer:	Flavio Lozano-Isla <flozanoisla@gmail.com>
Repository:	CRAN
Date/Publication:	2024-09-05 14:50:12 UTC

Barcode generator

Description

Generate bar codes using QR codes

Usage

barcode_qr(text, color = "black", alpha = 1, ecl = "H")

Arguments

Value

plot

Examples

library(huito)

barcode_qr("LIMA-2021-11-03_15_3_4")

Fieldbook experimental design

Description

The dataset were obtained using inti package. The data set is a randomize complete block design (RCBD) with three replications.

Usage

fieldbook

Format

A data frame with 24 rows and 5 variables:

barcode

barcode for each experimental unit

plots

Plot number

block

Blocks (3): number of replication in the design

condition

Factor with two levels: irrigated and drought

genotypes

Factor with four levels: choclito, salcedo, pandela, puno

Fonts import

Description

Import fonts from Google fonts

Usage

huito_fonts(fonts = NA)

Arguments

Details

For more fonts visit: https://fonts.google.com/

Value

fonts

Image import

Description

Import images and include R magick options

Usage

image_import(image, opts = NA)

Arguments

Value

image

Barcode layer

Description

Insert barcode in label

Usage

include_barcode(
  label,
  value,
  size,
  position = NA,
  type = "static",
  color = "auto",
  units = "cm"
)

Arguments

Value

data frame

Image layer

Description

Insert image in label

Usage

include_image(
  label,
  value,
  size,
  position = NA,
  type = "static",
  units = "cm",
  opts = NA
)

Arguments

Value

data frame

Shape layer

Description

Insert shape in label

Usage

include_shape(
  label,
  value = "hexagon",
  size = 5.08,
  position = NA,
  border_color = "black",
  border_width = 1,
  background = NA,
  units = "cm",
  panel_color = NA,
  panel_size = NA
)

Arguments

Value

data frame

Examples

library(huito)

label <- label_layout(data = NA
               , size = c(10, 2.5)
               , background = "yellow"
               ) %>%
         include_shape(
               value = "hexagon"
               , position = c(1.2, 1.25)
               , background = "red"
               , border_width = 1
               , size = 2.4
               #, panel_size = 2.4*1.157175
               )
               
label %>% label_print("sample")

ts <- label$opts
               

Text layer

Description

Insert text in label

Usage

include_text(
  label,
  value,
  position = NA,
  size = 11,
  font = NA,
  type = "static",
  color = NA,
  angle = 0,
  opts = NA
)

Arguments

Value

data frame

Label layout

Description

Generate labels options

Usage

label_layout(
  data = NA,
  size,
  border_width = NA,
  border_color = "black",
  background = NA,
  units = "cm"
)

Arguments

Value

data frame

Examples

label <- label_layout(size = c(10, 2.5)
                   , border_color = "red"
                   , border_width = 1
                   ) %>% 
                 label_print()

Label print

Description

Generate labels based in a data frame

Usage

label_print(
  label,
  mode = "sample",
  filename = "labels",
  margin = 0.04,
  paper = c(21, 29.7),
  units = "cm",
  viewer = FALSE,
  smpres = 200,
  nlabels = NA
)

Arguments

Value

pdf

Examples

library(huito)

fb <- fieldbook

label <- fb %>% 
label_layout(size = c(10, 2.5)
             , border_color = "blue"
             ) %>%
  include_image(
    value = "https://flavjack.github.io/inti/img/inkaverse.png"
    , size = c(2.4, 2.4)
    , position = c(1.2, 1.25)
    ) %>%
  include_barcode(
    value = "barcode"
    , size = c(2.5, 2.5)
    , position = c(8.2, 1.25)
    ) %>%
  include_text(value = "plots"
               , position = c(9.7, 1.25)
               , angle = 90
               , size = 15
               , color = "red"
               ) %>%
  include_text(value = "Inkaverse"
               , position = c(4.6, 2)
               , size = 30
               , color = "brown"
               ) %>%
  include_text(value = "condition"
               , position = c(4.6, 1.2)
               , size = 13
               , color = "orange"
               ) %>%
  include_text(value = "genotypes"
               , position = c(4.6, 0.5)
               , size = 13
               , color = "#009966"
               ) %>% 
               label_print(mode = "sample")
  

Objects exported from other packages

Description

These objects are imported from other packages. Follow the links below to see their documentation.

dplyr

%>%

Shape hexagon

Description

Hexagon geom shape for ggplot2

Usage

shape_hexagon(
  size = 5.08,
  border_width = NA,
  background = NA,
  border_color = "black",
  units = "cm",
  panel_color = "green",
  panel_size = NA
)

Arguments

Value

geom

Examples

library(huito)

shape_hexagon(border_width = 1
              , background = "red"
              #, panel_size = 5.08
              )