NAME
DMOSS - Data Mining Open Source Software
VERSION
version 0.01_2
SYNOPSIS
$ dmoss-process -f package-1.0.tgz
Data saved as dmoss.data
$ dmoss-report > package-1.0.html
DESCRIPTION
The DMOSS toolkit provides a framework for software packages (mainly non-source content) analysis. A set of plugins is distributed with the framework that provide a small set of analysis. For more information on available plugins and how to implement new plugins view the current plugins.
For performing software packages analysis please refer to dmoss-process and dmoss-report tools, and corresponding documentation.
More information about this framework can be found in this page, an example of a HTML report is available here.
FUNCTIONS
new
Create a new DMOSS object.
process
Process the package, compute attributes for files.
tree_process
Process package tree, reduce attributes for each level.
add_attr
Add an attribute to the the tree, this function is used by plugins to add data to a node in the tree (which represents a file).
report_attrs_plugin
This function is used in the reports modules to get a list of reports (one for each attribute) for a given plugin.
dt
Down translate, still under development (don't use).
save
Save dmoss object to a file (default is dmoss.data
) as a Storable
object.
to_stdout
Instead of saving object state to file, prints it to STDOUT
.
load
Load a dmoss object from a file (default is dmoss.data
), expects a Storable
object.
from_stdout
Instead of loading object from file, load from STDIN
.
PLUGINS
Current available plugins in this distribution are:
- "Plugin/AutoClassify.pm" in DMOSS
- "Plugin/CommentLines.pm" in DMOSS
- "Plugin/FunctionIdsDoc.pm" in DMOSS
- "Plugin/LinkValidator.pm" in DMOSS
- "Plugin/SpellChecker.pm" in DMOSS
- "Plugin/VerifyChanges.pm" in DMOSS
- "Plugin/VerifyLicense.pm" in DMOSS
AUTHOR
Nuno Carvalho <smash@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Project Natura <natura@natura.di.uminho.pt>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.