From 4645688ddd8c130c20a693631e49f0afa8e01dc1 Mon Sep 17 00:00:00 2001 From: coatless Date: Fri, 19 Jul 2024 08:43:47 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20coatless?= =?UTF-8?q?-rpkg/ucimlrepo@87a15283ddec1f368d6150d04dd710b8693d9890=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 4 ++-- pkgdown.yml | 2 +- reference/ucimlrepo-package.html | 4 ++-- search.json | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/index.html b/index.html index 513c33e..a64642f 100644 --- a/index.html +++ b/index.html @@ -11,8 +11,8 @@ - - + + Skip to contents diff --git a/pkgdown.yml b/pkgdown.yml index 850f94b..d3766d5 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.1.0 pkgdown_sha: ~ articles: {} -last_built: 2024-07-19T08:42Z +last_built: 2024-07-19T08:43Z urls: reference: https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference article: https://r-pkg.thecoatlessprofessor.com/ucimlrepo/articles diff --git a/reference/ucimlrepo-package.html b/reference/ucimlrepo-package.html index de570bc..3e78c43 100644 --- a/reference/ucimlrepo-package.html +++ b/reference/ucimlrepo-package.html @@ -1,5 +1,5 @@ -ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package • ucimlrepo +ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package • ucimlrepo Skip to contents @@ -33,7 +33,7 @@

ucimlrepo: Import UCI ML Datasets into R

-

Import datasets from the UC Irvine Machine Learning Repository into R scripts, notebooks, and 'Quarto'/'RMarkdown' documents.

+

Import datasets from the UCI Machine Learning Repository into R scripts, notebooks, and 'Quarto'/'RMarkdown' documents.

diff --git a/search.json b/search.json index 4c23a2e..3280286 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 ucimlrepo authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"James Joseph Balamuta. Author, maintainer, copyright holder. Philip Truong. Author, copyright holder.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Balamuta J, Truong P (2024). ucimlrepo: Import UCI ML Datasets R. R package version 0.0.0.9000, https://github.com/coatless-rpkg/ucimlrepo, https://r-pkg.thecoatlessprofessor.com/ucimlrepo/.","code":"@Manual{, title = {ucimlrepo: Import UCI ML Datasets into R}, author = {James Joseph Balamuta and Philip Truong}, year = {2024}, note = {R package version 0.0.0.9000, https://github.com/coatless-rpkg/ucimlrepo}, url = {https://r-pkg.thecoatlessprofessor.com/ucimlrepo/}, }"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/index.html","id":"ucimlrepo","dir":"","previous_headings":"","what":"Import UCI ML Datasets into R","title":"Import UCI ML Datasets into R","text":"goal ucimlrepo download import data sets directly R UCI Machine Learning Repository. [!IMPORTANT] package unoffical port Python ucimlrepo package.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Import UCI ML Datasets into R","text":"can install development version ucimlrepo GitHub :","code":"# install.packages(\"remotes\") remotes::install_github(\"coatless-rpkg/ucimlrepo\")"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Import UCI ML Datasets into R","text":"basic example shows solve common problem: package now loaded, can dowload dataset using fetch_repo() function. example, download iris dataset, can use: many levels data returned. example, can extract original data frame containing iris dataset using: can also directly query using ID: can also view list data sets available download using list_available_datasets() function:","code":"library(ucimlrepo) # Fetch a dataset by name iris_by_name <- fetch_ucirepo(name = \"iris\") names(iris_by_name) #> [1] \"data\" \"metadata\" \"variables\" iris_uci <- iris_by_name$data$original head(iris_uci) #> sepal.length sepal.width petal.length petal.width class #> 1 5.1 3.5 1.4 0.2 Iris-setosa #> 2 4.9 3.0 1.4 0.2 Iris-setosa #> 3 4.7 3.2 1.3 0.2 Iris-setosa #> 4 4.6 3.1 1.5 0.2 Iris-setosa #> 5 5.0 3.6 1.4 0.2 Iris-setosa #> 6 5.4 3.9 1.7 0.4 Iris-setosa # Fetch a dataset by id iris_by_id <- fetch_ucirepo(id = 53) # List available datasets list_available_datasets()"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch UCI ML Repository Dataset — fetch_ucirepo","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"Loads dataset UCI ML Repository, including dataframes metadata information.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"","code":"fetch_ucirepo(name, id)"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"name Character. Dataset name, substring name. id Integer. Dataset ID UCI ML Repository.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"list containing dataset metadata, dataframes, variable info properties. data: Contains dataset matrices pandas dataframes ids: Dataframe ID columns features: Dataframe feature columns targets: Dataframe target columns original: Dataframe consisting IDs, features, targets headers: List variable names/headers metadata: Contains metadata information dataset. uci_id: Unique dataset identifier UCI repository name: Name dataset UCI repository repository_url: Link dataset webpage UCI repository data_url: Link raw data file abstract: Short description dataset area: Subject area e.g. life science, business tasks: Associated machine learning tasks e.g. classification, regression characteristics: Dataset types e.g. multivariate, sequential num_instances: Number rows samples num_features: Number feature columns feature_types: Data types features target_col: Name target column(s) index_col: Name index column(s) has_missing_values: Whether dataset contains missing values missing_values_symbol: Indicates symbol represents missing entries (dataset missing values) year_of_dataset_creation: Year data set created dataset_doi: DOI registered dataset links UCI repo dataset page creators: List dataset creator names intro_paper: Information dataset's published introductory paper external_url: URL external dataset page. field exist linked datasets .e. hosted UCI additional_info: Descriptive free text dataset summary: General summary purpose: purpose dataset created? funded_by: funded creation dataset? instances_represent: instances dataset represent? recommended_data_splits: recommended data splits? sensitive_data: dataset contain data might considered sensitive way? preprocessing_description: data preprocessing performed? variable_info: Additional free text description variables citation: Citation Requests/Acknowledgements variables: Contains variable details presented tabular/dataframe format name: Variable name role: Whether variable ID, feature, target type: Data type e.g. categorical, integer, continuous demographic: Indicates whether variable represents demographic data description: Short description variable units: Variable units non-categorical data missing_values: Whether missing values variable's column","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"provide name id, .","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"","code":"if (FALSE) { # \\dontrun{ result <- fetch_ucirepo(name = \"iris\") result <- fetch_ucirepo(id = 1) } # }"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":null,"dir":"Reference","previous_headings":"","what":"List Available Datasets from UCI ML Repository — list_available_datasets","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"Prints list datasets can imported via fetch_ucirepo function.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"","code":"list_available_datasets(filter, search, area)"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"filter Character. Optional query filter available datasets based label. search Character. Optional query search available datasets name. area Character. Optional query filter available datasets based subject area.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"Prints list available datasets.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"","code":"if (FALSE) { # \\dontrun{ list_available_datasets(filter = \"python\") # Required for now... list_available_datasets(search = \"iris\") list_available_datasets(area = \"social science\") } # }"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/ucimlrepo-package.html","id":null,"dir":"Reference","previous_headings":"","what":"ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package","title":"ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package","text":"Import datasets UC Irvine Machine Learning Repository R scripts, notebooks, 'Quarto'/'RMarkdown' documents.","code":""},{"path":[]},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/ucimlrepo-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package","text":"Maintainer: James Joseph Balamuta james.balamuta@gmail.com (ORCID) [copyright holder] Authors: Philip Truong ucirepository@gmail.com [copyright holder]","code":""}] +[{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 ucimlrepo authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"James Joseph Balamuta. Author, maintainer, copyright holder. Philip Truong. Author, copyright holder.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Balamuta J, Truong P (2024). ucimlrepo: Import UCI ML Datasets R. R package version 0.0.0.9000, https://github.com/coatless-rpkg/ucimlrepo, https://r-pkg.thecoatlessprofessor.com/ucimlrepo/.","code":"@Manual{, title = {ucimlrepo: Import UCI ML Datasets into R}, author = {James Joseph Balamuta and Philip Truong}, year = {2024}, note = {R package version 0.0.0.9000, https://github.com/coatless-rpkg/ucimlrepo}, url = {https://r-pkg.thecoatlessprofessor.com/ucimlrepo/}, }"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/index.html","id":"ucimlrepo","dir":"","previous_headings":"","what":"Import UCI ML Datasets into R","title":"Import UCI ML Datasets into R","text":"goal ucimlrepo download import data sets directly R UCI Machine Learning Repository. [!IMPORTANT] package unoffical port Python ucimlrepo package.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Import UCI ML Datasets into R","text":"can install development version ucimlrepo GitHub :","code":"# install.packages(\"remotes\") remotes::install_github(\"coatless-rpkg/ucimlrepo\")"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Import UCI ML Datasets into R","text":"basic example shows solve common problem: package now loaded, can dowload dataset using fetch_repo() function. example, download iris dataset, can use: many levels data returned. example, can extract original data frame containing iris dataset using: can also directly query using ID: can also view list data sets available download using list_available_datasets() function:","code":"library(ucimlrepo) # Fetch a dataset by name iris_by_name <- fetch_ucirepo(name = \"iris\") names(iris_by_name) #> [1] \"data\" \"metadata\" \"variables\" iris_uci <- iris_by_name$data$original head(iris_uci) #> sepal.length sepal.width petal.length petal.width class #> 1 5.1 3.5 1.4 0.2 Iris-setosa #> 2 4.9 3.0 1.4 0.2 Iris-setosa #> 3 4.7 3.2 1.3 0.2 Iris-setosa #> 4 4.6 3.1 1.5 0.2 Iris-setosa #> 5 5.0 3.6 1.4 0.2 Iris-setosa #> 6 5.4 3.9 1.7 0.4 Iris-setosa # Fetch a dataset by id iris_by_id <- fetch_ucirepo(id = 53) # List available datasets list_available_datasets()"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":null,"dir":"Reference","previous_headings":"","what":"Fetch UCI ML Repository Dataset — fetch_ucirepo","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"Loads dataset UCI ML Repository, including dataframes metadata information.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"","code":"fetch_ucirepo(name, id)"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"name Character. Dataset name, substring name. id Integer. Dataset ID UCI ML Repository.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"list containing dataset metadata, dataframes, variable info properties. data: Contains dataset matrices pandas dataframes ids: Dataframe ID columns features: Dataframe feature columns targets: Dataframe target columns original: Dataframe consisting IDs, features, targets headers: List variable names/headers metadata: Contains metadata information dataset. uci_id: Unique dataset identifier UCI repository name: Name dataset UCI repository repository_url: Link dataset webpage UCI repository data_url: Link raw data file abstract: Short description dataset area: Subject area e.g. life science, business tasks: Associated machine learning tasks e.g. classification, regression characteristics: Dataset types e.g. multivariate, sequential num_instances: Number rows samples num_features: Number feature columns feature_types: Data types features target_col: Name target column(s) index_col: Name index column(s) has_missing_values: Whether dataset contains missing values missing_values_symbol: Indicates symbol represents missing entries (dataset missing values) year_of_dataset_creation: Year data set created dataset_doi: DOI registered dataset links UCI repo dataset page creators: List dataset creator names intro_paper: Information dataset's published introductory paper external_url: URL external dataset page. field exist linked datasets .e. hosted UCI additional_info: Descriptive free text dataset summary: General summary purpose: purpose dataset created? funded_by: funded creation dataset? instances_represent: instances dataset represent? recommended_data_splits: recommended data splits? sensitive_data: dataset contain data might considered sensitive way? preprocessing_description: data preprocessing performed? variable_info: Additional free text description variables citation: Citation Requests/Acknowledgements variables: Contains variable details presented tabular/dataframe format name: Variable name role: Whether variable ID, feature, target type: Data type e.g. categorical, integer, continuous demographic: Indicates whether variable represents demographic data description: Short description variable units: Variable units non-categorical data missing_values: Whether missing values variable's column","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"provide name id, .","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/fetch_ucirepo.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Fetch UCI ML Repository Dataset — fetch_ucirepo","text":"","code":"if (FALSE) { # \\dontrun{ result <- fetch_ucirepo(name = \"iris\") result <- fetch_ucirepo(id = 1) } # }"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":null,"dir":"Reference","previous_headings":"","what":"List Available Datasets from UCI ML Repository — list_available_datasets","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"Prints list datasets can imported via fetch_ucirepo function.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"","code":"list_available_datasets(filter, search, area)"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"filter Character. Optional query filter available datasets based label. search Character. Optional query search available datasets name. area Character. Optional query filter available datasets based subject area.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"Prints list available datasets.","code":""},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/list_available_datasets.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"List Available Datasets from UCI ML Repository — list_available_datasets","text":"","code":"if (FALSE) { # \\dontrun{ list_available_datasets(filter = \"python\") # Required for now... list_available_datasets(search = \"iris\") list_available_datasets(area = \"social science\") } # }"},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/ucimlrepo-package.html","id":null,"dir":"Reference","previous_headings":"","what":"ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package","title":"ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package","text":"Import datasets UCI Machine Learning Repository R scripts, notebooks, 'Quarto'/'RMarkdown' documents.","code":""},{"path":[]},{"path":"https://r-pkg.thecoatlessprofessor.com/ucimlrepo/reference/ucimlrepo-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"ucimlrepo: Import UCI ML Datasets into R — ucimlrepo-package","text":"Maintainer: James Joseph Balamuta james.balamuta@gmail.com (ORCID) [copyright holder] Authors: Philip Truong ucirepository@gmail.com [copyright holder]","code":""}]