README.md

In jeanmathieupotvin/cargo: Data containers, schemas and prototypes

cargo :: Data containers, schemas and prototypes

-blue.svg)

I have stopped development of this package. I am thinking about a total revamp / redesign that would make it much easier to use and much faster.

Package description

General low-level S4 containers for data, data schemes and prototypes. These containers brings formality and increased reliability at a negligible cost in resources. They are easily customizable through a user-friendly API and easily extendable to other S4 super-classes.

Development status

The package has recently moved from an exprimental stage to a working beta version (hence, the publication on Github). The package's intent is clear and its classes are already well defined. Nevertheless, a lot of work remains before its first official version / CRAN submission.

• The package needs to rely on R 4.0 (tests are ongoing).
• A vignette that introduces the package must be written.
• A tutorial vignette must also be written.
• An automated unit testing mechanism leveraging package testthat needs to be implemented.
• Some crucial mechanisms are still missing for class Container, notably setter functions that modify data by reference, (leveraging the data.table package).
• Extractors of class Container are still experimental when expression objects are passed to them. Beware!
• Class Container should also inherit class Schema.
• Another class Prototypes (or PrototypesCollection, a list of Prototype objects) needs to be implemented.
• Spatial tools needs to be (lightly) reorganized.

If you believe in the ideas proposed by cargo and you would like to collaborate, please send me an e-mail ([e-mail]). I would gladly like to collaborate with other people on this project!

Installation

Run these two lines of code in your R console.

library(devtools)
devtools::install_github("jeanmathieupotvin/cargo", dependencies = TRUE)

Binaries can also be downloaded from the official releases.

Getting help

Submit bugs and issues by clicking here.

Package's source structure

The package is structured in the usual way, as prescribed by CRAN's Writing R Extension Official Documentation. All files are encoded in UTF-8, because it's 2020.

• The NAMESPACE file can be generated anytime by calling devtools::document().
• The DESCRIPTION file can be generated by sourcing script _dev/dev_desc.R.
• Usual .Rd files listed in man/can be generated anytime by calling devtools::document().

Ignored in package's builds

These subdirectories are used for development purposes:

• _dev/ : scripts useful when building and updating the package.
• _doc/ : useful documentation.
• man-roxygen/ : package's documentation, written by using roxygen2.

These subdirectories are currently in development:

• tests/ : scripts for unit testing. The testthat package is used.
• vignettes/ : tutorials and long documentation.

These files are not needed in the package:

• READMEs : usual read-me files written in Markdown.
• cargo.Rproj : usual R project file.

Included in package's builds

• man/ : documentation files in raw .Rd format.

• R/ : source code of the package.

• LICENSEs : information on the chosen license (here MIT, for flexibility).

• NEWS.md : latest news and changes to the package.
• .Rbuildignore : files and directories to be ignored in builds.

Share and enjoy!

jeanmathieupotvin/cargo documentation built on Oct. 27, 2020, 5:22 p.m.