diff --git a/ChangeLog b/ChangeLog index f1a63a9..fc355df 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,5 @@ 2017-11-06 George G. Vega Yon - * Solving CRAN comments. + * Solving CRAN comments. And a bunch of misspelled words. 2017-11-05 George G. Vega Yon diff --git a/NEWS.md b/NEWS.md index ce6c85e..3141c02 100644 --- a/NEWS.md +++ b/NEWS.md @@ -46,7 +46,7 @@ * The encoding issue is definetly solved (on utf8). -* Avoiding unnecesary warings while assigning geo:location attributes. +* Avoiding unnecessary warings while assigning geo:location attributes. * Fixing some bugs when checking for duplicated concepts diff --git a/R/dspl.r b/R/dspl.r index 666b69b..ababd09 100644 --- a/R/dspl.r +++ b/R/dspl.r @@ -34,17 +34,17 @@ #' bundle with a more complete concepts definition including description, url, #' etc.. #' -#' If there isn't any output defiend (\code{NA}) the function returns a +#' If there isn't any output defined (\code{NA}) the function returns a #' dataframe containing concepts as observations. Using this, the user may add -#' more descripting info about concepts. In turn it writes a tab file with the +#' more descriptive info about concepts. In turn it writes a tab file with the #' dataframe described above. The user may recycle this file writing ``append'' #' in the \code{action} argument. #' #' @param path String. Path to the folder where the tables are saved. -#' @param encoding The enconding of the files to be parsed. +#' @param encoding The encoding of the files to be parsed. #' @param sep The separation character of the tables in the 'path' folder. #' Currently supports introducing the following arguments: ``,'' or ``;'' (for -#' .csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for microsofts +#' .csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for Microsoft's #' excel files). #' @param output If defined, the place where to save the dataframe as tab file. #' Otherwise it returns a data frame object. @@ -54,11 +54,11 @@ #' @return If no \code{output} defined, \code{genMoreInfo} returns a dataframe #' with the following columns. \item{id}{XML id of the concept #' (autogenerated)} \item{label}{The label of the concept (autogenerated)} -#' \item{description}{A breif description of the concept} \item{topic}{The +#' \item{description}{A brief description of the concept} \item{topic}{The #' topic of the concept} \item{url}{A URL for the concept where, for example, -#' to get more info} \item{totalName}{A total name as specified by DSPL languge -#' (works for dimentional concepts)} \item{pluralName}{A total name as -#' specified by DSPL language (works for dimentional concepts)} +#' to get more info} \item{totalName}{A total name as specified by DSPL language +#' (works for dimensional concepts)} \item{pluralName}{A total name as +#' specified by DSPL language (works for dimensional concepts)} #' @author George G. Vega Yon #' @references Google Public Data Explorer: \url{http://publicdata.google.com} #' @keywords IO @@ -572,7 +572,7 @@ seekTables <- function(files, encoding, sep, output = NA, replace = T, dec) { #' If there isn't any output defined the function returns a list of class #' \code{dspl} that among its contents has a xml object (DSPL file); otherwise, #' if an output is defined, the results consists on two things, an already ZIP -#' file containing a all the necesary to be uploaded at +#' file containing a all the necessary to be uploaded at #' \url{publicdata.google.com} (a collection of csv files and the XML DSPL #' written file) and a message (character object). #' @@ -582,8 +582,8 @@ seekTables <- function(files, encoding, sep, output = NA, replace = T, dec) { #' \item Generating each column corresponding id, #' \item Identifying the data types, #' \item Building concepts, -#' \item Identifying dimentional concepts and distinguishing between categorical, -#' geographical and time dimentions, and +#' \item Identifying dimensional concepts and distinguishing between categorical, +#' geographical and time dimensions, and #' \item Executing internal checks. #' } #' @@ -591,10 +591,10 @@ seekTables <- function(files, encoding, sep, output = NA, replace = T, dec) { #' function executes a series of internal checks upon the data structure. The #' detailed list: #' \itemize{ -#' \item \strong{Slices with the same dimentions}: DSPL -#' requires that each slice represents one dimentional cut, this is, there -#' shouldn't be more than one data table with the same dimensions. -#' \item \strong{Duplicated concetps}: As a result of multiple data types, e.g a single +#' \item \strong{Slices with the same dimensions}: DSPL +#' requires that each slice represents one dimensional cut, this is, there +#' should not be more than one data table with the same dimensions. +#' \item \strong{Duplicated concepts}: As a result of multiple data types, e.g a single #' concept (statistic) as integer in one table and float in other, \code{dspl} #' may get confused, so during the parsing process, if there is a chance, it #' collapses duplicated concepts into only one concept and assigns it the @@ -627,11 +627,11 @@ seekTables <- function(files, encoding, sep, output = NA, replace = T, dec) { #' @param providerURL List of strings. The data provider website url. #' @param sep The separation character of the tables in the 'path' folder. #' Currently supports introducing the following arguments: ``,'' or ``;'' (for -#' .csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for microsofts +#' .csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for Microsoft's #' excel files). #' @param dec String. Decimal point. #' @param encoding The char encoding of the input tables. Currently ignored for -#' microsoft excel files. +#' Microsoft excel files. #' @param moreinfo A special tab file generated by the function #' \code{\link{genMoreInfo}} that contains a dataframe of the dataset concepts #' with more specifications such as description, topic, url, etc. @@ -642,10 +642,10 @@ seekTables <- function(files, encoding, sep, output = NA, replace = T, dec) { #' \item{dspl}{A character string containing the DSPL XML document as defined #' by the \code{\link[XML:saveXML]{saveXML}} function.} #' \item{concepts.by.table}{A data frame object of concepts stored by table.} -#' \item{dimtabs}{A data frame containing dimentional tables.} +#' \item{dimtabs}{A data frame containing dimensional tables.} #' \item{slices}{A data frame of slices.} #' \item{concepts}{A data frame of concepts (all of them).} -#' \item{dimentions}{A data frame of dimentional concepts.} +#' \item{dimensions}{A data frame of dimensional concepts.} #' \item{statistics}{A matrix of statistics.} #' #' otherwise the function will build a ZIP file as specified in the output @@ -858,7 +858,7 @@ dspl <- function( NROW(.dims) ), ncol=3) - colnames(pde.statistics) <- c('slices','concepts','dimentions') + colnames(pde.statistics) <- c('slices','concepts','dimensions') result <- structure( .Data= @@ -867,7 +867,7 @@ dspl <- function( .dims, pde.statistics ), .Names = c( - 'dspl', 'concepts.by.table', 'dimtabs', 'slices', 'concepts', 'dimentions', + 'dspl', 'concepts.by.table', 'dimtabs', 'slices', 'concepts', 'dimensions', 'statistics'), class = "dspl" ) diff --git a/R/googlepublicdata.r b/R/googlepublicdata.r index 4161294..8fdd3e6 100644 --- a/R/googlepublicdata.r +++ b/R/googlepublicdata.r @@ -6,7 +6,7 @@ NULL #' World countries example data set #' #' This data set is one used in the DSPL Tutorial. Specifically, it contains -#' the basic columns used to define geographical dimentions, in this case, +#' the basic columns used to define geographical dimensions, in this case, #' countries. #' #' @@ -51,7 +51,7 @@ NULL #' @param path String. Output path where to save the XML DSPL file. #' @param replace Logical. If \code{path} exists, \code{TRUE} would replace the #' file. -#' @param quiet Whether or not to print infor on the screen +#' @param quiet Whether or not to print information on the screen #' @param \dots arguments passed on to \code{\link{cat}} (\code{print.dspl}) #' @return \item{list("print.dspl")}{ None (invisible \code{NULL}).} #' @@ -103,7 +103,7 @@ NULL #' Genders example data set #' #' This data set is one used in the DSPL Tutorial. Specifically, it contains -#' the basic columns used to define a categorical dimentions such as gender. +#' the basic columns used to define a categorical dimensions such as gender. #' #' #' @name genders @@ -122,7 +122,7 @@ NULL #' #' \code{googlePublicData} package provides a collection of functions to set up #' Google Public Data Explorer data visualization tool with your own data, -#' building automaticaly the corresponding DSPL (XML) metadata file jointly +#' building automatically the corresponding DSPL (XML) metadata file jointly #' with the CSV files. All zipped up and ready to be published at Public Data #' Explorer. #' @@ -182,8 +182,8 @@ NULL #' US states example data set #' #' This data set is one used in the DSPL Tutorial. Specifically, it contains -#' the basic columns used to define geographical dimentions, in this case, US -#' Satates. +#' the basic columns used to define geographical dimensions, in this case, US +#' States. #' #' #' @name states diff --git a/R/jodatimes.r b/R/jodatimes.r index 26229e0..e1f0c4e 100644 --- a/R/jodatimes.r +++ b/R/jodatimes.r @@ -24,7 +24,7 @@ colnames(.joda.times) <- c('regex','format','example') #' DSPL language. #' #' Public Data Explorer currently supports daily, monthly and yearly -#' distributed data. Joda-time, the corresponding time format on wich DSPL +#' distributed data. Joda-time, the corresponding time format on which DSPL #' times is based, allows declaring time formats using small case "d" (for #' days), capitalized "M" (for months) and small case "y" for years. Some #' examples: \tabular{ll}{ Format Specification \tab Data Example\cr "yyyy" diff --git a/R/pdemethods.r b/R/pdemethods.r index 78dbe1e..0f2e0aa 100644 --- a/R/pdemethods.r +++ b/R/pdemethods.r @@ -42,5 +42,5 @@ summary.dspl <- function(object, ...) { print(attributes(object)) cat('Dataset contents\n') object[c('dimtabs', 'slices', 'concepts', - 'dimentions','statistics')] + 'dimensions','statistics')] } diff --git a/inst/NEWS b/inst/NEWS index dd6e3b9..b13b6ba 100644 --- a/inst/NEWS +++ b/inst/NEWS @@ -63,7 +63,8 @@ DEVELOPMENT - The encoding issue is definetly solved (on utf8). -- Avoiding unnecesary warings while assigning geo:location attributes. +- Avoiding unnecessary warings while assigning + geo:location attributes. - Fixing some bugs when checking for duplicated concepts diff --git a/man/checkTimeFormat.Rd b/man/checkTimeFormat.Rd index 1ac1b73..c935fde 100644 --- a/man/checkTimeFormat.Rd +++ b/man/checkTimeFormat.Rd @@ -20,7 +20,7 @@ DSPL language. } \details{ Public Data Explorer currently supports daily, monthly and yearly -distributed data. Joda-time, the corresponding time format on wich DSPL +distributed data. Joda-time, the corresponding time format on which DSPL times is based, allows declaring time formats using small case "d" (for days), capitalized "M" (for months) and small case "y" for years. Some examples: \tabular{ll}{ Format Specification \tab Data Example\cr "yyyy" diff --git a/man/countries.Rd b/man/countries.Rd index 75548c7..1c3a6a1 100644 --- a/man/countries.Rd +++ b/man/countries.Rd @@ -11,7 +11,7 @@ DSPL Google Code Page Downloads: } \description{ This data set is one used in the DSPL Tutorial. Specifically, it contains -the basic columns used to define geographical dimentions, in this case, +the basic columns used to define geographical dimensions, in this case, countries. } \keyword{datasets} diff --git a/man/dspl-methods.Rd b/man/dspl-methods.Rd index b462970..3bec5c4 100644 --- a/man/dspl-methods.Rd +++ b/man/dspl-methods.Rd @@ -20,7 +20,7 @@ \item{replace}{Logical. If \code{path} exists, \code{TRUE} would replace the file.} -\item{quiet}{Whether or not to print infor on the screen} +\item{quiet}{Whether or not to print information on the screen} \item{\dots}{arguments passed on to \code{\link{cat}} (\code{print.dspl})} diff --git a/man/dspl.Rd b/man/dspl.Rd index 428a33e..c91c183 100644 --- a/man/dspl.Rd +++ b/man/dspl.Rd @@ -54,13 +54,13 @@ supports multiple description as the \code{name}} \item{sep}{The separation character of the tables in the 'path' folder. Currently supports introducing the following arguments: ``,'' or ``;'' (for -.csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for microsofts +.csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for Microsoft's excel files).} \item{dec}{String. Decimal point.} \item{encoding}{The char encoding of the input tables. Currently ignored for -microsoft excel files.} +Microsoft excel files.} \item{moreinfo}{A special tab file generated by the function \code{\link{genMoreInfo}} that contains a dataframe of the dataset concepts @@ -74,10 +74,10 @@ An object of class "\code{dspl}" is a list containing: \item{dspl}{A character string containing the DSPL XML document as defined by the \code{\link[XML:saveXML]{saveXML}} function.} \item{concepts.by.table}{A data frame object of concepts stored by table.} -\item{dimtabs}{A data frame containing dimentional tables.} +\item{dimtabs}{A data frame containing dimensional tables.} \item{slices}{A data frame of slices.} \item{concepts}{A data frame of concepts (all of them).} -\item{dimentions}{A data frame of dimentional concepts.} +\item{dimensions}{A data frame of dimensional concepts.} \item{statistics}{A matrix of statistics.} otherwise the function will build a ZIP file as specified in the output @@ -93,7 +93,7 @@ files) ready to be uploaded to Google Public Data Explorer. If there isn't any output defined the function returns a list of class \code{dspl} that among its contents has a xml object (DSPL file); otherwise, if an output is defined, the results consists on two things, an already ZIP -file containing a all the necesary to be uploaded at +file containing a all the necessary to be uploaded at \url{publicdata.google.com} (a collection of csv files and the XML DSPL written file) and a message (character object). @@ -103,8 +103,8 @@ Internally, the parsing process consists on the following steps: \item Generating each column corresponding id, \item Identifying the data types, \item Building concepts, -\item Identifying dimentional concepts and distinguishing between categorical, -geographical and time dimentions, and +\item Identifying dimensional concepts and distinguishing between categorical, +geographical and time dimensions, and \item Executing internal checks. } @@ -112,10 +112,10 @@ In order to properly load the zip file (DSPL file plus CSV data files), the function executes a series of internal checks upon the data structure. The detailed list: \itemize{ -\item \strong{Slices with the same dimentions}: DSPL -requires that each slice represents one dimentional cut, this is, there -shouldn't be more than one data table with the same dimensions. -\item \strong{Duplicated concetps}: As a result of multiple data types, e.g a single +\item \strong{Slices with the same dimensions}: DSPL +requires that each slice represents one dimensional cut, this is, there +should not be more than one data table with the same dimensions. +\item \strong{Duplicated concepts}: As a result of multiple data types, e.g a single concept (statistic) as integer in one table and float in other, \code{dspl} may get confused, so during the parsing process, if there is a chance, it collapses duplicated concepts into only one concept and assigns it the diff --git a/man/genMoreInfo.Rd b/man/genMoreInfo.Rd index 5e2f40b..52b94c4 100644 --- a/man/genMoreInfo.Rd +++ b/man/genMoreInfo.Rd @@ -10,11 +10,11 @@ genMoreInfo(path, encoding = getOption("encoding"), sep = ";", \arguments{ \item{path}{String. Path to the folder where the tables are saved.} -\item{encoding}{The enconding of the files to be parsed.} +\item{encoding}{The encoding of the files to be parsed.} \item{sep}{The separation character of the tables in the 'path' folder. Currently supports introducing the following arguments: ``,'' or ``;'' (for -.csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for microsofts +.csv files), ``\\t'' (for .tab files) and ``xls'' or ``xlsx'' (for Microsoft's excel files).} \item{output}{If defined, the place where to save the dataframe as tab file. @@ -29,11 +29,11 @@ Available actions are ``merge'' and ``replace''.} If no \code{output} defined, \code{genMoreInfo} returns a dataframe with the following columns. \item{id}{XML id of the concept (autogenerated)} \item{label}{The label of the concept (autogenerated)} -\item{description}{A breif description of the concept} \item{topic}{The +\item{description}{A brief description of the concept} \item{topic}{The topic of the concept} \item{url}{A URL for the concept where, for example, -to get more info} \item{totalName}{A total name as specified by DSPL languge -(works for dimentional concepts)} \item{pluralName}{A total name as -specified by DSPL language (works for dimentional concepts)} +to get more info} \item{totalName}{A total name as specified by DSPL language +(works for dimensional concepts)} \item{pluralName}{A total name as +specified by DSPL language (works for dimensional concepts)} } \description{ Parsing \emph{csv}, \emph{tab} or \emph{xls(x)} files at a specific @@ -42,9 +42,9 @@ bundle with a more complete concepts definition including description, url, etc.. } \details{ -If there isn't any output defiend (\code{NA}) the function returns a +If there isn't any output defined (\code{NA}) the function returns a dataframe containing concepts as observations. Using this, the user may add -more descripting info about concepts. In turn it writes a tab file with the +more descriptive info about concepts. In turn it writes a tab file with the dataframe described above. The user may recycle this file writing ``append'' in the \code{action} argument. } diff --git a/man/genders.Rd b/man/genders.Rd index 5483184..661aa68 100644 --- a/man/genders.Rd +++ b/man/genders.Rd @@ -11,6 +11,6 @@ DSPL Google Code Page Downloads: } \description{ This data set is one used in the DSPL Tutorial. Specifically, it contains -the basic columns used to define a categorical dimentions such as gender. +the basic columns used to define a categorical dimensions such as gender. } \keyword{datasets} diff --git a/man/googlePublicData.Rd b/man/googlePublicData.Rd index 603705f..eeac74a 100644 --- a/man/googlePublicData.Rd +++ b/man/googlePublicData.Rd @@ -9,7 +9,7 @@ \description{ \code{googlePublicData} package provides a collection of functions to set up Google Public Data Explorer data visualization tool with your own data, -building automaticaly the corresponding DSPL (XML) metadata file jointly +building automatically the corresponding DSPL (XML) metadata file jointly with the CSV files. All zipped up and ready to be published at Public Data Explorer. } diff --git a/man/states.Rd b/man/states.Rd index 6cac603..38df18d 100644 --- a/man/states.Rd +++ b/man/states.Rd @@ -11,7 +11,7 @@ DSPL Google Code Page Downloads: } \description{ This data set is one used in the DSPL Tutorial. Specifically, it contains -the basic columns used to define geographical dimentions, in this case, US -Satates. +the basic columns used to define geographical dimensions, in this case, US +States. } \keyword{datasets} diff --git a/readme.md b/readme.md index bf1cef7..2479937 100644 --- a/readme.md +++ b/readme.md @@ -9,13 +9,13 @@ Features: - Reads tab, csv, xls and xlsx from a folder. -- Identifies data types and distinguishes between dimentional and metric concepts. +- Identifies data types and distinguishes between dimensional and metric concepts. -- Identifies dimentional data tabs. +- Identifies dimensional data tabs. - Auto generates conceps id. -- Auto data sorting on dimentional (no time) concepts. +- Auto data sorting on dimensional (no time) concepts. - Prints XML and csv files to upload to Public Data Explorer. diff --git a/readme.rmd b/readme.rmd index 921a306..1a171f7 100644 --- a/readme.rmd +++ b/readme.rmd @@ -14,13 +14,13 @@ Features: * Reads tab, csv, xls and xlsx from a folder. -* Identifies data types and distinguishes between dimentional and metric concepts. +* Identifies data types and distinguishes between dimensional and metric concepts. -* Identifies dimentional data tabs. +* Identifies dimensional data tabs. * Auto generates conceps id. -* Auto data sorting on dimentional (no time) concepts. +* Auto data sorting on dimensional (no time) concepts. * Prints XML and csv files to upload to Public Data Explorer.