App::lcpan::Cmd::related_mods - List other modules related to module(s)
This document describes version 1.061 of App::lcpan::Cmd::related_mods (from Perl distribution App-lcpan), released on 2020-06-11.
handle_cmd(%args) -> [status, msg, payload, meta]
List other modules related to module(s).
This subcommand lists other modules that might be related to the module(s) you specify. This is done by listing modules that tend be mentioned together in POD documentation.
The scoring/ranking still needs to be tuned.
This function is not exported.
Arguments ('*' denotes required arguments):
cpan => dirname
Location of your local CPAN mirror, e.g. /path/to/cpan.
index_name => filename (default: "index.db")
Filename of index.
index_nameis a filename without any path, e.g.
index.dbthen index will be located in the top-level of
index_namecontains a path, e.g.
/home/ujang/lcpan.dbthen the index will be located solely using the
limit => int (default: 20)
Maximum number of modules to return.
modules* => array[perl::modname]
skip_same_dist => bool
Skip modules from the same distribution.
sort => array[str] (default: ["-score","-num_mentions"])
use_bootstrap => bool (default: 1)
Whether to use bootstrap database from App-lcpan-Bootstrap.
If you are indexing your private CPAN-like repository, you want to turn this off.
with_scores => bool
Return score-related fields.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/App-lcpan.
Source repository is at https://github.com/perlancar/perl-App-lcpan.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-lcpan
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
This software is copyright (c) 2020, 2019, 2018, 2017, 2016, 2015 by firstname.lastname@example.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.