diff --git a/NAMESPACE b/NAMESPACE index e57835f..ea2aa46 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -7,7 +7,6 @@ export(enrich_author_name) export(finna_cite) export(finna_interactive) export(get_finna_records) -export(integrate_metadata) export(load_offline_data) export(refine_metadata) export(save_for_offline) diff --git a/R/analysisFinna.R b/R/analysis_finna.R similarity index 100% rename from R/analysisFinna.R rename to R/analysis_finna.R diff --git a/R/integrateFinna.R b/R/integrateFinna.R deleted file mode 100644 index c53d69b..0000000 --- a/R/integrateFinna.R +++ /dev/null @@ -1,28 +0,0 @@ -#' Integrate Finna Metadata with Another Dataset -#' -#' Merges Finna metadata with another dataset using a common key (e.g., "Title"). -#' -#' @param metadata1 A tibble containing refined Finna metadata. -#' @param metadata2 A tibble containing another dataset to merge with the Finna metadata. -#' @param key A string specifying the key to join by. Defaults to "Title". -#' @return A tibble containing the merged dataset. -#' @import dplyr -#' @export -#' @examples -#' library(dplyr) -#' finna_data <- search_finna("sibelius") -#' -#' # Example other dataset to merge with -#' other_data <- tibble::tibble( -#' Title = c("Sibelius Symphony No. 5", "Finlandia", "Valse Triste"), -#' Rating = c(5, 4, 3) -#' ) -#' -#' # Integrate the two datasets by "Title" -#' integrated_data <- integrate_metadata(finna_data, other_data, key = "Title") -#' print(integrated_data) -integrate_metadata <- function(metadata1, metadata2, key = "Title") { - # Perform a full join based on the specified key - integrated <- full_join(metadata1, metadata2, by = key) - return(integrated) -} diff --git a/R/refinemetaData.R b/R/refine_metadata.R similarity index 86% rename from R/refinemetaData.R rename to R/refine_metadata.R index 4c31be0..e55bf9e 100644 --- a/R/refinemetaData.R +++ b/R/refine_metadata.R @@ -1,6 +1,9 @@ #' Refine Finna Metadata #' #' 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. #' #' @param data A tibble containing raw Finna metadata. #' @return A tibble with selected, cleaned metadata fields, or NULL if required fields are missing. diff --git a/R/visualizeFinna.R b/R/visualize_finna.R similarity index 100% rename from R/visualizeFinna.R rename to R/visualize_finna.R diff --git a/man/analyze_metadata.Rd b/man/analyze_metadata.Rd index 3fc5a6a..c2afd2a 100644 --- a/man/analyze_metadata.Rd +++ b/man/analyze_metadata.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/analysisFinna.R +% Please edit documentation in R/analysis_finna.R \name{analyze_metadata} \alias{analyze_metadata} \title{Analyze Refined Finna Metadata} diff --git a/man/integrate_metadata.Rd b/man/integrate_metadata.Rd deleted file mode 100644 index 6b328d1..0000000 --- a/man/integrate_metadata.Rd +++ /dev/null @@ -1,35 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/integrateFinna.R -\name{integrate_metadata} -\alias{integrate_metadata} -\title{Integrate Finna Metadata with Another Dataset} -\usage{ -integrate_metadata(metadata1, metadata2, key = "Title") -} -\arguments{ -\item{metadata1}{A tibble containing refined Finna metadata.} - -\item{metadata2}{A tibble containing another dataset to merge with the Finna metadata.} - -\item{key}{A string specifying the key to join by. Defaults to "Title".} -} -\value{ -A tibble containing the merged dataset. -} -\description{ -Merges Finna metadata with another dataset using a common key (e.g., "Title"). -} -\examples{ -library(dplyr) -finna_data <- search_finna("sibelius") - -# Example other dataset to merge with -other_data <- tibble::tibble( - Title = c("Sibelius Symphony No. 5", "Finlandia", "Valse Triste"), - Rating = c(5, 4, 3) -) - -# Integrate the two datasets by "Title" -integrated_data <- integrate_metadata(finna_data, other_data, key = "Title") -print(integrated_data) -} diff --git a/man/refine_metadata.Rd b/man/refine_metadata.Rd index 6ab33c6..f998e25 100644 --- a/man/refine_metadata.Rd +++ b/man/refine_metadata.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/refinemetaData.R +% Please edit documentation in R/refine_metadata.R \name{refine_metadata} \alias{refine_metadata} \title{Refine Finna Metadata} @@ -14,6 +14,9 @@ A tibble with selected, cleaned metadata fields, or NULL if required fields are } \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. } \examples{ library(finna) diff --git a/man/visualize_author_distribution.Rd b/man/visualize_author_distribution.Rd index ddc21c8..de1d9f8 100644 --- a/man/visualize_author_distribution.Rd +++ b/man/visualize_author_distribution.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_author_distribution} \alias{visualize_author_distribution} \title{Visualize Distribution by Authors} diff --git a/man/visualize_format_distribution.Rd b/man/visualize_format_distribution.Rd index b23588f..122db70 100644 --- a/man/visualize_format_distribution.Rd +++ b/man/visualize_format_distribution.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_format_distribution} \alias{visualize_format_distribution} \title{Visualize Distribution by Formats} diff --git a/man/visualize_format_distribution_pie.Rd b/man/visualize_format_distribution_pie.Rd index 0ab3e51..efcdc60 100644 --- a/man/visualize_format_distribution_pie.Rd +++ b/man/visualize_format_distribution_pie.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_format_distribution_pie} \alias{visualize_format_distribution_pie} \title{Visualize Format Distribution as Pie Chart} diff --git a/man/visualize_format_library_correlation.Rd b/man/visualize_format_library_correlation.Rd index fed48d2..24f9855 100644 --- a/man/visualize_format_library_correlation.Rd +++ b/man/visualize_format_library_correlation.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_format_library_correlation} \alias{visualize_format_library_correlation} \title{Visualize Correlation Between Formats and Libraries} diff --git a/man/visualize_library_distribution.Rd b/man/visualize_library_distribution.Rd index 5c4c765..7a71b10 100644 --- a/man/visualize_library_distribution.Rd +++ b/man/visualize_library_distribution.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_library_distribution} \alias{visualize_library_distribution} \title{Visualize Distribution by Libraries} diff --git a/man/visualize_subject_distribution.Rd b/man/visualize_subject_distribution.Rd index c15a72b..6b586aa 100644 --- a/man/visualize_subject_distribution.Rd +++ b/man/visualize_subject_distribution.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_subject_distribution} \alias{visualize_subject_distribution} \title{Visualize Distribution by Subjects} diff --git a/man/visualize_title_year_heatmap.Rd b/man/visualize_title_year_heatmap.Rd index 08a8ee8..bf1c535 100644 --- a/man/visualize_title_year_heatmap.Rd +++ b/man/visualize_title_year_heatmap.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_title_year_heatmap} \alias{visualize_title_year_heatmap} \title{Visualize Heatmap of Titles by Year} diff --git a/man/visualize_top_20_titles.Rd b/man/visualize_top_20_titles.Rd index cb85bc5..09d7f4d 100644 --- a/man/visualize_top_20_titles.Rd +++ b/man/visualize_top_20_titles.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_top_20_titles} \alias{visualize_top_20_titles} \title{Visualize Top-20 Titles by Count} diff --git a/man/visualize_word_cloud.Rd b/man/visualize_word_cloud.Rd index 55ec80d..389b9d7 100644 --- a/man/visualize_word_cloud.Rd +++ b/man/visualize_word_cloud.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_word_cloud} \alias{visualize_word_cloud} \title{Visualize Word Cloud of Titles or Subjects with Stop Words Removal} diff --git a/man/visualize_year_distribution.Rd b/man/visualize_year_distribution.Rd index 6be57c0..20d4ce3 100644 --- a/man/visualize_year_distribution.Rd +++ b/man/visualize_year_distribution.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_year_distribution} \alias{visualize_year_distribution} \title{Visualize Year Distribution} diff --git a/man/visualize_year_distribution_line.Rd b/man/visualize_year_distribution_line.Rd index 9210ba9..6cbd774 100644 --- a/man/visualize_year_distribution_line.Rd +++ b/man/visualize_year_distribution_line.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/visualizeFinna.R +% Please edit documentation in R/visualize_finna.R \name{visualize_year_distribution_line} \alias{visualize_year_distribution_line} \title{Visualize Year Distribution (Line Plot)} diff --git a/vignettes/articles/refinemetadata.Rmd b/vignettes/articles/refinemetadata.Rmd index e19f9b0..8965462 100644 --- a/vignettes/articles/refinemetadata.Rmd +++ b/vignettes/articles/refinemetadata.Rmd @@ -9,9 +9,14 @@ vignette: > # Introduction -This vignette provides an overview of how to use the finna package. +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. + +This refinement process makes the metadata more consistent and user-friendly, reducing potential issues in subsequent analysis or reporting. -### **Refine using ` refine_metadata()` function** ```{r} library(finna) @@ -20,17 +25,27 @@ refined_data <- refine_metadata(sibelius_data) print(refined_data) ``` -### **integrate using ` integrate_metadata()` Function** +### **integrate to other metadata ** +To integrate two datasets using full_join() from dplyr, you can write the code directly like this: +```{r message = FALSE, warning = FALSE} +library(dplyr) -```{r} -finna_data <- search_finna("sibelius") +# Example Finna metadata (metadata1) +finna_data <- search_finna("sibelius",limit = 4) + +# Example other dataset to merge with (metadata2) other_data <- tibble::tibble( Title = c("Sibelius Symphony No. 5", "Finlandia", "Valse Triste"), Rating = c(5, 4, 3) ) -integrated_data <- integrate_metadata(finna_data, other_data, key = "Title") + +# Integrate the two datasets using full_join by the "Title" column +integrated_data <- full_join(finna_data, other_data, by = "Title") + +# Print the integrated dataset print(integrated_data) + ```