How to create a public or private LOEP plugin with new evaluation models and metrics

How to create a public or private LOEP plugin with new evaluation models and metrics

1. How to create a LOEP plugin
2. How to add new evaluation models and metrics to a LOEP plugin

---

How to create a LOEP plugin

The first step to create a LOEP plugin is execute the following command in the root path of the LOEP application:

rails plugin new pluginName --full

This will create a folder called pluginName in the root path of the LOEP application which should be moved to the loep_plugins folder as follows:

mv pluginName loep_plugins/

Then, we need to add the plugin to the application_config.yml file in order to enable it. For that, we should add pluginName to the array specified in the plugins key.

After that, we need to execute the following command:

bundle install

By default, the created plugin located at /loep_plugins/pluginName will not be uploaded to the public repository so it will remain private. If you want to make the plugin public, you can add an exception in the .gitignore file as follows:

!loep_plugins/pluginName

Finally, you can specify different settings for the plugin in the following files located at /loep_plugins/pluginName: README.rdoc and pluginName.gemspec. By default a file called MIT-LICENSE is created at the root of the plugin path. You are free to remove such a file and specify the license you want in the README.rdoc file. If you remove the MIT-LICENSE file, remove also the reference to the file included in the pluginName.gemspec file.
 
LOEP plugins can be used to provide new evaluations models and/or metrics. Next section explains how to do that. Besides, since LOEP plugins are Rails engines, they can be used to provide new features or to override original features. You can check this guide for further information.

How to add new evaluation models and metrics to a LOEP plugin

Coming soon...