issues #5 and #6

rOpenGov · Nov 13, 2024 · b0d56ec · b0d56ec
1 parent a0004d0
commit b0d56ec
Show file tree

Hide file tree

Showing 20 changed files with 40 additions and 83 deletions.
diff --git 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 → R/analysis_finna.R b/R/analysisFinna.R → R/analysis_finna.R
diff --git a/R/integrateFinna.R b/R/integrateFinna.R
diff --git a/R/refinemetaData.R → R/refine_metadata.R b/R/refinemetaData.R → 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 → R/visualize_finna.R b/R/visualizeFinna.R → R/visualize_finna.R
diff --git a/man/analyze_metadata.Rd b/man/analyze_metadata.Rd
diff --git a/man/integrate_metadata.Rd b/man/integrate_metadata.Rd
diff --git a/man/refine_metadata.Rd b/man/refine_metadata.Rd
diff --git a/man/visualize_author_distribution.Rd b/man/visualize_author_distribution.Rd
diff --git a/man/visualize_format_distribution.Rd b/man/visualize_format_distribution.Rd
diff --git a/man/visualize_format_distribution_pie.Rd b/man/visualize_format_distribution_pie.Rd
diff --git a/man/visualize_format_library_correlation.Rd b/man/visualize_format_library_correlation.Rd
diff --git a/man/visualize_library_distribution.Rd b/man/visualize_library_distribution.Rd
diff --git a/man/visualize_subject_distribution.Rd b/man/visualize_subject_distribution.Rd
diff --git a/man/visualize_title_year_heatmap.Rd b/man/visualize_title_year_heatmap.Rd
diff --git a/man/visualize_top_20_titles.Rd b/man/visualize_top_20_titles.Rd
diff --git a/man/visualize_word_cloud.Rd b/man/visualize_word_cloud.Rd
diff --git a/man/visualize_year_distribution.Rd b/man/visualize_year_distribution.Rd
diff --git a/man/visualize_year_distribution_line.Rd b/man/visualize_year_distribution_line.Rd
diff --git 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)
+
 ```