CRAN compabtible version

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: finna
-Title: Title: R Package for Finna API
+Title: Title: Access the 'Finna' API
 Version: 0.1.1
 Date: 2025-01-10
 Authors@R: c(
@@ -9,7 +9,7 @@ Authors@R: c(
            comment = c(ORCID = "0000-0001-5537-637X"))
   )
 Maintainer: Akewak Jeba <[email protected]>  
-Description: Provides functions to access and retrieve metadata from the Finna API, which aggregates content from Finnish archives, libraries, and museums.
+Description: Provides functions to access and retrieve metadata from the 'Finna' API <https://api.finna.fi/>, which aggregates content from Finnish archives, libraries, and museums.
 License: BSD_2_clause + file LICENSE
 Encoding: UTF-8
 Imports: 
@@ -22,14 +22,8 @@ Imports:
     readr,
     tibble,
     curl,
-    rlang,
-    stringr,
-    tidyr,
     progress,
-    purrr,
-    tm,
-    stopwords,
-    wordcloud2
+    purrr
 Suggests: 
     testthat (>= 3.0.0),
     rmarkdown,

NAMESPACE

@@ -15,9 +15,7 @@ export(load_offline_data)
 export(refine_metadata)
 export(save_for_offline)
 export(search_finna)
-export(search_finna_from_file)
 export(search_publisher)
-export(timeline_relative)
 export(top_plot)
 import(dplyr)
 import(progress)
@@ -32,10 +30,16 @@ importFrom(dplyr,mutate)
 importFrom(dplyr,select)
 importFrom(dplyr,summarise)
 importFrom(ggplot2,aes)
+importFrom(ggplot2,coord_flip)
+importFrom(ggplot2,geom_bar)
 importFrom(ggplot2,geom_line)
+importFrom(ggplot2,geom_text)
 importFrom(ggplot2,ggplot)
 importFrom(ggplot2,labs)
+importFrom(ggplot2,scale_y_log10)
 importFrom(ggplot2,theme_minimal)
+importFrom(ggplot2,xlab)
+importFrom(ggplot2,ylab)
 importFrom(glue,glue)
 importFrom(httr,GET)
 importFrom(httr,content)

R/enrich_author_name.R

@@ -1,21 +1,21 @@
-#' @title Enrich Author Name from Finna API and Save Results
+#' @title Enrich Author Name from 'Finna' API and Save Results
 #'
 #' @description
 #' This function reads a CSV file from a URL containing Melinda IDs and author names.
-#' If the author name is missing (NA), it searches Finna for the corresponding Melinda ID
+#' If the author name is missing (NA), it searches the 'Finna' API for the corresponding Melinda ID
 #' to retrieve and update the author name. The updated data is saved in a CSV file.
 #'
 #' @param url A character string specifying the URL of the CSV file with Melinda IDs and author names.
 #' @param output_file A character string specifying the output CSV file name.
-#' @return A tibble of the updated data, and the file is saved to the `data` directory.
+#' @return A tibble with updated author names. The file is saved to a temporary directory using \code{tempdir()}.
 #' @importFrom readr read_csv write_csv cols col_character
 #' @importFrom dplyr mutate if_else
 #' @importFrom purrr map_chr
 #' @export
 #' @examples
 #' \dontrun{
 #' enrich_author_name(url = "https://example/na_author_rows.csv",
-#' output_file = "updated_na_author_rows.csv")
+#'                    output_file = "updated_na_author_rows.csv")
 #' }
 enrich_author_name <- function(url, output_file = "updated_na_author_rows.csv") {
 
@@ -38,10 +38,6 @@ enrich_author_name <- function(url, output_file = "updated_na_author_rows.csv")
       if (!is.null(results) && nrow(results) > 0) {
         authors <- results$Author[1]
         return(authors)
-      } else if (httr::status_code(response) == 429) {
-        message("Rate limit reached. Waiting for ", wait_time, " seconds before retrying.")
-        Sys.sleep(wait_time)
-        attempt <- attempt + 1
       } else {
         return(NA)
       }
@@ -55,7 +51,7 @@ enrich_author_name <- function(url, output_file = "updated_na_author_rows.csv")
     author_name = readr::col_character()
   ))
 
-  # Step 2: Update `author_name` if it is 'NA' by fetching from Finna
+  # Step 2: Update `author_name` if it is 'NA' by fetching from 'Finna'
   data <- data %>%
     dplyr::mutate(
       updated_author_name = dplyr::if_else(
@@ -70,17 +66,10 @@ enrich_author_name <- function(url, output_file = "updated_na_author_rows.csv")
       )
     )
 
-  # Ensure the 'data' directory exists
-  if (!dir.exists("data")) {
-    dir.create("data")
-  }
-
-  # Define output file path
-  output_csv_path <- file.path("data", output_file)
-
-  # Step 3: Save the updated data as CSV
+  # Step 3: Save the updated data as CSV in a temporary directory
+  output_csv_path <- file.path(tempdir(), output_file)
   readr::write_csv(data, output_csv_path)
   message("CSV file with updated author names saved to ", output_csv_path)
 
-  return(data)  # Return the updated tibble as well
+  return(data)  # Return the updated tibble
 }

R/finna_cite.R

@@ -6,6 +6,7 @@
 #' @param result The Finna collection result as a tibble.
 #' @param index The index of the collection to cite (numeric).
 #' @param style The citation style to use (default: "citation"). See \code{\link[utils]{bibentry}}.
+#' @return A bibliographic entry (\code{bibentry}) printed in the specified style.
 #' @export
 finna_cite <- function(result, index, style = "citation") {
   # Validate the input structure

R/refine_metadata.R

@@ -1,10 +1,18 @@
 #' @title Refine Finna Metadata
 #'
 #' @description
-#' Refines the Finna metadata tibble by keeping relevant fields and cleaning up missing values.
-#' The purpose of the refine_metadata function is to: Ensure completeness by filling in missing
-#' values with placeholder text, Standardize key metadata fields for easier analysis, Select only
-#' the most relevant fields, simplifying the dataset.
+#' The `refine_metadata` function cleans and standardizes Finna metadata by:
+#' - **Validating Required Fields:** Checks for the presence of key metadata fields and returns `NULL` if any are missing.
+#' - **Handling Missing Values:** Replaces `NA` values in critical fields with descriptive placeholder text (e.g., "Unknown Title").
+#' - **Selecting Relevant Fields:** Keeps only the following fields for streamlined analysis:
+#'   - `Title`: The title of the resource.
+#'   - `Author`: The creator or author of the resource.
+#'   - `Year`: The publication or release year.
+#'   - `Language`: The language of the resource.
+#'   - `Formats`: The format(s) of the resource (e.g., Book, Audio).
+#'   - `Subjects`: The subject keywords or classifications.
+#'   - `Library`: The owning library or institution.
+#'   - `Series`: The series or collection the resource belongs to.
 #'
 #' @param data A tibble containing raw Finna metadata.
 #' @return A tibble with selected, cleaned metadata fields, or NULL if required fields are missing.

R/save_for_offline.R

@@ -1,30 +1,27 @@
-#' @title Save Finna Search Results for Offline Access
+#' @title Save 'Finna' Search Results for Offline Access
 #'
 #' @description
-#' This function saves Finna search results and metadata locally to a file in `.rds` format,
+#' This function saves 'Finna' search results and metadata locally to a file in `.rds` format,
 #' allowing users to access and analyze the data offline without an internet connection.
 #'
-#' @param data A tibble or data frame containing the Finna search results.
+#' @param data A tibble or data frame containing the 'Finna' search results.
 #' @param file_name A string representing the name of the file to save.
 #'   The function automatically appends ".rds" to the name if not already included.
-#' @return A message confirming that the data has been saved successfully.
+#' @return No return value. Called for its side effects of saving the data to a file.
 #' @examples
 #' \dontrun{
 #' search_results <- search_finna("sibelius")
 #' save_for_offline(search_results, "sibelius_search_results")
 #' }
 #' @export
 save_for_offline <- function(data, file_name = "offline_search_results") {
-  # Ensure the data directory exists
-  dir.create("data", showWarnings = FALSE)
-
   # Ensure the file name has the .rds extension
   if (!grepl("\\.rds$", file_name)) {
     file_name <- paste0(file_name, ".rds")
   }
 
-  # Define the full file path
-  full_path <- file.path("data", file_name)
+  # Define the full file path in a temporary directory
+  full_path <- file.path(tempdir(), file_name)
 
   if (!is.null(data) && nrow(data) > 0) {
     saveRDS(data, full_path)
@@ -34,28 +31,30 @@ save_for_offline <- function(data, file_name = "offline_search_results") {
   }
 }
 
-#' Load Finna Search Results from Offline File
+#' @title Load 'Finna' Search Results from Offline File
 #'
 #' @description
-#' This function loads previously saved Finna search results from a local `.rds` file for offline access.
+#' This function loads previously saved 'Finna' search results from a local `.rds` file for offline access.
 #'
 #' @param file_name A string representing the name of the file to load.
 #'   The function automatically appends ".rds" if not already included.
-#' @return The loaded search results in tibble format.
-#' @export
+#' @return A tibble or data frame containing the loaded search results.
 #' @examples
 #' \dontrun{
+#' search_results <- search_finna("sibelius")
+#' save_for_offline(search_results, "sibelius_search_results")
 #' offline_data <- load_offline_data("sibelius_search_results")
 #' print(offline_data)
 #' }
+#' @export
 load_offline_data <- function(file_name = "offline_search_results") {
   # Ensure the file name has the .rds extension
   if (!grepl("\\.rds$", file_name)) {
     file_name <- paste0(file_name, ".rds")
   }
 
-  # Define the full file path
-  full_path <- file.path("data", file_name)
+  # Define the full file path in the temporary directory
+  full_path <- file.path(tempdir(), file_name)
 
   if (file.exists(full_path)) {
     data <- readRDS(full_path)
@@ -65,11 +64,3 @@ load_offline_data <- function(file_name = "offline_search_results") {
     stop("File not found. Please ensure the file exists and try again.")
   }
 }
-
-# Example Usage:
-# search_results <- search_finna("sibelius")
-# save_for_offline(search_results, "sibelius_search_results")  # Saves as "data/sibelius_search_results.rds"
-
-# Load the search results back later
-# offline_results <- load_offline_data("sibelius_search_results")
-# print(offline_results)

R/top_plot.R

@@ -10,6 +10,7 @@
 #' @param show.percentage Show the proportion of each category with respect to the total sample count.
 #' @param log10 Show the counts on log10 scale (default FALSE)
 #' @return ggplot object
+#' @importFrom ggplot2 geom_bar coord_flip xlab ylab geom_text scale_y_log10
 #' @export
 #' @author Leo Lahti \email{leo.lahti@@iki.fi}
 #' @references See citation("bibliographica")