update roxygen and re-upload to cran

Author: kleanthisk10

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: tableschema.r
 Type: Package
 Title: Table Schema 'Frictionless Data'
-Version: 1.1.2
+Version: 1.1.3
 Date: 2022-09-29
 Authors@R: c(person("Kleanthis", "Koupidis", email = "koupidis@okfn.gr", role = c("aut", "cre")), 
             person("Lazaros", "Ioannidis", email = "larjohn@gmail.com", role = "aut"),
@@ -72,5 +72,5 @@ Collate:
     'tableschema.r.R'
     'validate.R'
     'writable.R'
-RoxygenNote: 7.2.1 
+RoxygenNote: 7.3.1 
 Roxygen: list(r6 = FALSE)

Makefile

@@ -4,6 +4,9 @@ output:
   github_document:
     html_preview: yes
 ---
+#### tableschema-r v1.1.3
+
+update roxygen documentation
 
 #### tableschema-r v1.1.2
 

NEWS.Rmd

@@ -1,6 +1,10 @@
 NEWS
 ================
 
+#### tableschema-r v1.1.3
+
+update roxygen documentation
+
 #### tableschema-r v1.1.2
 
 update links in documentation

NEWS.md

@@ -1,105 +1,78 @@
-#' Field class
+#' @title Field class
+#'
+#' @description Class representing a field in the schema.
+#'
+#' Data values can be cast to native R types. Casting a value checks whether it is of the expected type, in the correct format, and compliant with any constraints imposed by the schema.
+#'
+#' @usage
+#' # Field$new(descriptor, missingValues = list(""))
+#'
+#' @param descriptor Schema field descriptor.
+#' @param missingValues A list with vector strings representing missing values.
 #'
-#' @description Class represents field in the schema.
-#' 
-#' Data values can be cast to native R types. Casting a value will check 
-#' the value is of the expected type, is in the correct format, 
-#' and complies with any constraints imposed by a schema.
-#' 
-#' @usage # Field$new(descriptor, missingValues = list(""))
-#' @param descriptor Schema field descriptor
-#' @param missingValues A list with vector strings representing missing values
-#' 
-#' 
 #' @section Methods:
 #' \describe{
-#' 
-#' \item{\code{Field$new(descriptor, missingValues = list(""))}}{
-#'Constructor to instantiate \code{Field} class.}
-#' \itemize{
-#'  \item{\code{descriptor }}{Schema field descriptor.}  
-#'  \item{\code{missingValues }}{A list with vector strings representing missing values.}
-#'  \item{\code{TableSchemaError }}{Raises any error occured in the process.}
-#'  \item{\code{Field }}{Returns \code{Field} class instance.}
-#'  }
-#'   \item{\code{cast_value(value, constraints=TRUE)}}{
-#'   Cast given value according to the field type and format.}
-#' \itemize{
-#'  \item{\code{value }}{Value to cast against field}  
-#'  \item{\code{constraints  }}{ Gets constraints configuration: 
-#'  it could be set to true to disable constraint checks, or 
-#'  it could be a List of constraints to check}
-#'  \item{\code{errors$TableSchemaError }}{Raises any error occured in the process}
-#'  \item{\code{any }}{Returns cast value}
-#'  }
-#'  
-#' \item{\code{testValue(value, constraints=TRUE)}}{
-#'   Test if value is compliant to the field.}
-#' \itemize{
-#'  \item{\code{value }}{Value to cast against field}  
-#'  \item{\code{constraints  }}{Constraints configuration}
-#'  \item{\code{Boolean }}{Returns if value is compliant to the field}
-#'  }
+#'   \item{\code{Field$new(descriptor, missingValues = list(""))}}{Constructor to instantiate the \code{Field} class. Accepts the following arguments:
+#'     \describe{
+#'       \item{\code{descriptor}}{Schema field descriptor.}
+#'       \item{\code{missingValues}}{A list of strings representing missing values.}
+#'       \item{\code{TableSchemaError}}{Raised if an error occurs during instantiation.}
+#'       \item{\code{Field}}{Returns a \code{Field} class instance.}
+#'     }
+#'   }
+#'
+#'   \item{\code{cast_value(value, constraints = TRUE)}}{Casts a given value according to the field's type and format.
+#'     \describe{
+#'       \item{\code{value}}{Value to cast.}
+#'       \item{\code{constraints}}{Logical or list of constraints to apply.}
+#'       \item{\code{errors$TableSchemaError}}{Raised if casting fails due to a constraint violation.}
+#'       \item{\code{any}}{Returns the cast value.}
+#'     }
+#'   }
+#'
+#'   \item{\code{testValue(value, constraints = TRUE)}}{Tests if a value complies with the field definition.
+#'     \describe{
+#'       \item{\code{value}}{Value to test.}
+#'       \item{\code{constraints}}{Constraints configuration.}
+#'       \item{\code{Boolean}}{Returns \code{TRUE} if the value is compliant.}
+#'     }
+#'   }
 #' }
-#' 
+#'
 #' @section Properties:
 #' \describe{
-#'   \item{\code{name}}{Returns field name}
-#'   \item{\code{type}}{Returns field type}
-#'   \item{\code{format}}{Returns field format}
-#'   \item{\code{required}}{Returns \code{TRUE} if field is required}
-#'   \item{\code{constraints}}{Returns list with field constraints}
-#'   \item{\code{descriptor}}{Returns field descriptor}
+#'   \item{\code{name}}{Returns the field name.}
+#'   \item{\code{type}}{Returns the field type.}
+#'   \item{\code{format}}{Returns the field format.}
+#'   \item{\code{required}}{Returns \code{TRUE} if the field is required.}
+#'   \item{\code{constraints}}{Returns a list of field constraints.}
+#'   \item{\code{descriptor}}{Returns the field descriptor.}
 #' }
-#'  
-#' 
-#' @details 
-#' A field descriptor \code{MUST} be a JSON object that describes a single field. 
-#' The descriptor provides additional human-readable documentation for a field, 
-#' as well as additional information that may be used to validate the field or 
-#' create a user interface for data entry.
-#' 
-#' The field descriptor \code{object} \code{MAY} contain any number of other properties. 
-#' Some specific properties are defined below. Of these, only the \code{name} property is \code{REQUIRED}.
-#' 
+#'
+#' @details
+#' A field descriptor \code{MUST} be a JSON object that describes a single field. The descriptor provides both human-readable documentation and machine-readable validation rules. It may also guide user interface generation for data entry.
+#'
+#' The descriptor \code{object} \code{MAY} include additional custom properties. Of these, only the \code{name} property is \code{REQUIRED}.
+#'
 #' \describe{
-#' \item{\code{name}}{
-#' The field descriptor \code{MUST} contain a \code{name} property. 
-#' This property \code{SHOULD} correspond to the name of field/column in the data file (if it has a name). 
-#' As such it \code{SHOULD} be unique (though it is possible, but very bad practice, for the data file to 
-#' have multiple columns with the same name). \code{name} \code{SHOULD NOT} be considered case sensitive in 
-#' determining uniqueness. However, since it should correspond to the name of the field in the data file 
-#' it may be important to preserve case.}
-#' \item{\code{title}}{
-#' A human readable label or title for the field.}
-#' 
-#' \item{\code{description}}{
-#' A description for this field e.g. "The recipient of the funds".}
+#'   \item{\code{name}}{The descriptor \code{MUST} contain a \code{name} property, typically corresponding to the column name in the data file. This name \code{SHOULD} be unique, and while not case-sensitive for uniqueness, preserving case is advisable.}
+#'   \item{\code{title}}{A human-readable label for the field.}
+#'   \item{\code{description}}{A text description of the field, e.g., "The recipient of the funds".}
 #' }
-#' 
-#' 
-#' 
+#'
 #' @section Language:
-#' The key words \code{MUST}, \code{MUST NOT}, \code{REQUIRED}, \code{SHALL}, \code{SHALL NOT}, 
-#' \code{SHOULD}, \code{SHOULD NOT}, \code{RECOMMENDED}, \code{MAY}, and \code{OPTIONAL} 
-#' in this package documents are to be interpreted as described in \href{https://www.ietf.org/rfc/rfc2119.txt}{RFC 2119}.
-#' 
-#' 
+#' The key words \code{MUST}, \code{MUST NOT}, \code{REQUIRED}, \code{SHALL}, \code{SHALL NOT}, \code{SHOULD}, \code{SHOULD NOT}, \code{RECOMMENDED}, \code{MAY}, and \code{OPTIONAL} in this documentation are to be interpreted as described in \href{https://www.ietf.org/rfc/rfc2119.txt}{RFC 2119}.
+#'
 #' @docType class
 #' @importFrom R6 R6Class
 #' @export
 #' @include types.R
 #' @include constraints.R
 #' @keywords data
-#' @return Object of \code{\link{R6Class}} .
+#' @return Object of class \code{\link{R6Class}}.
 #' @format \code{\link{R6Class}} object.
-#' @param base_path see description
-#' @param strict see description
-#' @param value see description
-#' @param constraints see description
-#' @param ... see description
+#'
 #' @seealso \href{https://specs.frictionlessdata.io//table-schema/#field-descriptors}{Field Descriptors Specifications}
-#'  
 #' @examples 
 #' DESCRIPTOR = list(name = "height", type = "number")
 #' 

R/field.R

@@ -8,7 +8,7 @@
 #'  \item readable stream with CSV file contents
 #'  \item function returning readable stream with CSV file contents
 #'  }
-#' @param options any \code{\link{Table.load}} options
+#' @param options any \code{Table.load} options
 #' @rdname infer
 #' @export
 #' @return Schema descriptor

R/infer.R

@@ -1,43 +1,41 @@
-#' Profile class
-#' @description Class to represent JSON Schema profile from \href{https://specs.frictionlessdata.io/schemas/registry.json}{Profiles Registry}.
-#' 
-#' @usage # Profile.load(profile)
-#' @param profile string profile name in registry or URL to JSON Schema
-#' 
-#' 
+#' @title Profile class
+#'
+#' @description Class to represent a JSON Schema profile from the \href{https://specs.frictionlessdata.io/schemas/registry.json}{Profiles Registry}.
+#'
+#' @usage
+#' # Profile$load(profile)
+#'
+#' @param profile String: the name of a profile from the registry or a URL pointing to a JSON Schema.
+#'
 #' @section Methods:
 #' \describe{
-#' 
-#' \item{\code{Profile$new(descriptor = descriptor)}}{
-#' Use \code{\link{Profile.load}} to instantiate \code{Profile} class.}
-#' 
-#'   \item{\code{validate(descriptor)}}{
-#' Validate a tabular data package descriptor against the \code{Profile}.}
-#' \itemize{
-#'  \item{\code{descriptor }}{Retrieved and dereferenced tabular data package descriptor.}  
-#'  \item{\code{(Object) }}{Returns \code{TRUE} if descriptor is valid or \code{FALSE} with error message.}
-#'  }
+#'   \item{\code{Profile$new(descriptor = descriptor)}}{Use \code{Profile$load} to instantiate a \code{Profile} class.}
 #'
+#'   \item{\code{validate(descriptor)}}{Validate a tabular data package descriptor against the \code{Profile}.
+#'     \describe{
+#'       \item{\code{descriptor}}{The dereferenced tabular data package descriptor to validate.}
+#'       \item{Return value}{Returns \code{TRUE} if the descriptor is valid; otherwise returns \code{FALSE} with an error message.}
+#'     }
+#'   }
 #' }
-#' 
+#'
 #' @section Properties:
 #' \describe{
-#'   \item{\code{name}}{Returns profile name if available.}
-#'   \item{\code{jsonschema}}{Returns profile JSON Schema contents.}
+#'   \item{\code{name}}{Returns the profile name, if available.}
+#'   \item{\code{jsonschema}}{Returns the contents of the profile's JSON Schema.}
 #' }
-#' 
+#'
 #' @seealso \href{https://specs.frictionlessdata.io//profiles/}{Profile Specifications}
-#' 
+#'
 #' @docType class
 #' @importFrom R6 R6Class
 #' @export
 #' @include types.R
 #' @include constraints.R
 #' @include tableschemaerror.R
 #' @keywords data
-#' @return Object of \code{\link{R6Class}} .
+#' @return Object of class \code{\link{R6Class}}.
 #' @format \code{\link{R6Class}} object.
-#' 
 
 Profile <- R6Class(
   "Profile",