readMLData

Help for package readMLData const macros = { "\\R": "\\textsf{R}", "\\mbox": "\\text", "\\code": "\\texttt"}; function processMathHTML() { var l = document.getElementsByClassName('reqn'); for (let e of l) { katex.render(e.textContent, e, { throwOnError: false, macros }); } return; } Package {readMLData} Contents readMLData-package analyzeData checkConsistency checkType dsDownload dsRead dsSearch dsSort getAvailable getFields getPath getType prepareDSList xml Type: Package Title: Reading Machine Learning Benchmark Data Sets in Different Formats Version: 0.9-7 Date: 2015-01-13 Author: Petr Savicky Maintainer: Petr Savicky <savicky@cs.cas.cz> Description: Functions for reading data sets in different formats for testing machine learning tools are provided. This allows to run a loop over several data sets in their original form, for example if they are downloaded from UCI Machine Learning Repository. The data are not part of the package and have to be downloaded separately. Imports: XML License: GPL-3 URL: http://www.cs.cas.cz/~savicky/readMLData Packaged: 2015-01-13 10:52:09 UTC; savicky NeedsCompilation: no Repository: CRAN Date/Publication: 2015-01-13 12:10:48 Reading data from different sources in their original format. Description The package contains functions, which allow to maintain and use a structure describing a collection of machine learning datasets and read them into R environment using a unified interface, see function prepareDSList() and dsRead() . Details The data are not part of the package. The package requires to receive a path to a local copy of the data and their description. The description of the data sets consists of a directory, which contains an XML file contents.xml and subdirectory "scripts", which contains an R script for each data set, which reads the data set into R. File contents.xml contains information on all the data sets. In particular it contains their names for local identification, their public names, and the names of files representing the data set. The name of the script for reading a data set is derived from its identification name. The complete list of the fields in contents.xml may be obtained using getFields() . For the simplest use of the package for reading the data sets, the functions prepareDSList() and dsRead() are sufficient. The remaining functions are useful for including further data sets to the description. Use help(package=readMLData) or library(help=readMLData) to see the list of functions. The list of fields, which should be included in "contents.xml" , consists of the fields with either usage=="obligatory" or usage=="optional" in the table produced by getFields() . Fields with usage=="additional" and usage=="computed" are included automatically by the function prepareDSList() . An example of the description directory describing three UCI data sets is in exampleDescription subdirectory of the installed package. The data themselves are in exampleData subdirectory. See http://www.cs.cas.cz/~savicky/readMLData/ for description files of further data sets from UCI Machine Learning Repository. Author(s) Petr Savicky References UCI Machine Learning Repository, http://archive.ics.uci.edu/ml/ . Additional resources for the CRAN package readMLData, http://www.cs.cas.cz/~savicky/readMLData/ . Determine the type of values in each column of a data frame. Description For each column, its class and the number of different values is determined. For numeric columns, also the minimum and maximum is computed. Usage analyzeData(dat) Arguments dat A data frame. Value A data frame with columns "class", "num.unique", "min", "max" , which correspond to properties of columns of dat . The rows in the output data frame correspond to the columns of dat . Author(s) Petr Savicky See Also readMLData . Examples pathData <- getPath("exampleData") pathDescription <- getPath("exampleDescription") dsList <- prepareDSList(pathData, pathDescription) dat <- dsRead(dsList, "glass") analyzeData(dat) Checks consistency of the data frame dsList . Description Checks consistency of the parameters specified for each dataset in the dsList data frame created by prepareDSList() . Usage checkConsistency(dsList, outputInd=FALSE) Arguments dsList Data frame as created by prepareDSList() . outputInd Logical. Determines, whether the output should be a vector of indices of the data sets with conflicts. Value Depending on outputInd , either a vector of indices of data sets with a conflict between the specified parameters or NULL invisibly. Author(s) Petr Savicky See Also readMLData . Examples pathData <- getPath("exampleData") pathDescription <- getPath("exampleDescription") dsList <- prepareDSList(pathData, pathDescription) checkConsistency(dsList) Compares the type of columns stored in dsList and in a data set itself. Description Compares types. Usage checkType(dsList, id, dat=NULL) Arguments dsList Data frame describing the data sets as produced by prepareDSList() . id Numeric or character of length one. Index or the identification of a data set. dat An optional data frame as read by dsRead(dsList, id, keepContents=TRUE) . Value The name of the tested data set and the result of the test is printed. If errors are found, a more detailed message is printed. The output value is TRUE or FALSE invisibly according, whether the types are correct or not. Author(s) Petr Savicky See Also readMLData . Examples pathData <- getPath("exampleData") pathDescription <- getPath("exampleDescription") dsList <- prepareDSList(pathData, pathDescription) checkType(dsList, 1) Run an external tool to download a data set. Description The function allows to run an external download tool with arguments read from a file in a data folder. Usage dsDownload(dsList, id, command, fileName) Arguments dsList Data frame as created by prepareDSList() . id Name of the data set in dsList$identification or the index of the row in dsList corresponding to the data set. command Character. A command line web downloding tool, for example "wget" . fileName Character. A name of the file in the data directory, which contains the URL of the data on the web. Details If no data set or more than one data set corresponding to id is found, a corresponding error message is printed. Value Function has no value. The protocol generated by the specified tool is printed. Author(s) Petr Savicky See Also readMLData . Examples ## Not run: pathData <- getPath("exampleData") pathDescription <- getPath("exampleDescription") dsList <- prepareDSList(pathData, pathDescription) dat <- dsDownload(dsList, "glass", "wget", "links.txt") ## End(Not run) Loading machine learning data from a directory tree using a unified interface. Description The function allows to read data sets included in the description in the data frame dsList into R environment using a unified interface. Usage dsRead(dsList, id, responseName = NULL, originalNames=TRUE, deleteUnused=TRUE, keepContents=FALSE) Arguments dsList Data frame as created by prepareDSList() . id Name of the data set in dsList$identification or the index of the row in dsList corresponding to the data set. responseName Character. The required name of the response column in the output data frame created from the data set. originalNames If TRUE, the original names of columns are used, if they are present in the description XML file. deleteUnused Logical. Controls, whether the columns containing case labels or other columns not suitable as attributes, are removed from the data. keepContents Logical. If TRUE , then deleteUnused parameter is ignored and no columns are converted to factors. Details The function uses dsList$avaiable to determine, whether the files for the required data set is present in the local directory dsList$pathData . If not, a corresponding error message is printed. See prepareDSList() and getAvailable() . Value A data frame containing the required data set, possibly transformed according to the setting of the parameters responseName, originalNames, deleteUnused