R/read_au_ici.R

In RaoulWolf/cleanventory: A Package to Clean Chemical Inventory Data Sets

#' @title Read-In and Clean the Australia Industrial Chemicals Inventory
#' @description This function reads-in and automatically cleans the Australia
#'   Industrial Chemicals Inventory.
#' @param path (Character) The path to the XLSX file.
#' @param clean_non_ascii (Logical) Should the non-ASCII characters be
#'   reasonably converted? Defaults to \code{FALSE}.
#' @details This function reads-in and automatically cleans the Australia
#'   Industrial Chemicals Inventory.
#' @return Returns a data frame.
#' @author Raoul Wolf (\url{https://github.com/RaoulWolf/})
#' @note Tested with the 10 February 2022 version.
#' @examples \dontrun{
#' download.file(
#'   url = paste(
#'     "https://www.industrialchemicals.gov.au/sites/default/files/2022-03",
#'     paste(
#'       "Full%20list%20of%20chemicals%20on%20the%20Inventory%20",
#'       "%2010%20February%202022.XLSX",
#'       sep = "-"
#'     ),
#'   sep = "/"
#'   ),
#'   destfile = paste(
#'     "Full list of chemicals on the Inventory",
#'     "10 February 2022.xlsx",
#'     sep = " - "
#'   )
#' )
#'
#' path <- "Full list of chemicals on the Inventory - 10 February 2022.xlsx"
#'
#' ici <- read_au_ici(path)
#' }
#' @importFrom openxlsx read.xlsx
#' @export
read_au_ici <- function(path, clean_non_ascii = FALSE) {

  if (!is.logical(clean_non_ascii) || is.na(clean_non_ascii)) {
    clean_non_ascii <- FALSE
  }

  ici <- openxlsx::read.xlsx(xlsxFile = path, startRow = 2, cols = 1:5)

  names(ici) <- c(
    "cr_no", "cas_no", "cas_name", "aicis_approved_chemical_name_aacn",
    "molecular_formula"
  )

  ici <- transform(
    ici,
    cr_no = as.integer(cr_no),
    cas_no = ifelse(
      test = .check_cas(cas_no),
      yes = cas_no,
      no = NA_character_
    )
  )

  if (clean_non_ascii) {
    ici <- transform(
      ici,
      cas_name = .clean_non_ascii(cas_name),
      molecular_formula = .clean_non_ascii(molecular_formula)
    )
  }

  ici

}