fantasy-f1-analyzer

    1.4.0 • Public • Published

    Fantasy F1 Analyser

    Version node-current Codacy Badge GitHub issues Snyk Vulnerabilities for GitHub Repo Libraries.io dependency status for latest release NPM Downloads Total NPM Downloads/Month Last Commit Licence

    A command line utility which retrieves the latest Fantasy F1 results and analyses all possible constructor and driver combinations and suggests an optimum Fantasy F1 Team. FF1 Analyser

    Overview

    I started playing Fantasy F1 for the first time this season (2022) and, like most players, I'd juggle my team around before each race weekend's qualifying session. There were a few obvious front-runners but the rest of my team selection lacked any satisfactory analysis, and instead was borne from drivers I'd like to see do well who fell inside the budget cap restrictions.

    So I wrote this tool.

    The Fantasy F1 Analyser consumes the Fantasy F1 League's public APIs to retrieve the latest driver & constructor standings. It then works through >150,000 permutations of possible Fantasy F1 teams and tallies their score. The team combination(s) with the highest points tally to date (and which falls with the budget cap) are reported back.

    If multiple team combinations result the same highest points tally then they are all reported back. The current qualifying and finishing streaks are also reported in case that helps your selection.

    FF1 Analyser - Running

    Disclaimer

    This tool is not affiliated with the Fantasy F1 League. It is a personal project I've open sourced. This tool is not a predictor; it uses historical data to retrospectively suggest what would have been a optimal team selection to this point, and is intended for use a baseline for your own team selection.

    Installation

    Install globally via npm using:

    npm install -g fantasy-f1-analyzer

    Usage

    Start an analysis via the command:

    ff1 [options]

    Options

    There are a few command line options you can use:

       --export <filename>           Exports the results to the specified filename
       --year <nnnn>                 Override the default season. Default: 2022
       --budget <nnn>                Override the default budget cap. Default: 100
       --worst                       Displays the team with the worst points tally instead of the best
       --progressinterval <n>        Update analysis progress every nth team. Default: 5
       --verbose                     Enables verbose output.
       --debug                       Enables debugging output.
       --no-color                    Switches off colour output.
       --version                     Display version number.
       --help                        Display help screen.
    

    export

    --export <filename>

    The export option allows you write the results to the specific filename. The output format the CSV and filename will be automatically appended with .csv if needed.

    year

    --year <nnnn>

    Specifies the season's year in case there's a need to override the default.

    Default: The current date's four digit year (e.g. 2022).

    budget

    --budget <nnn>

    Specifies the budget cap in case there's a need to override the default.

    Default: 100.

    worst

    --worst displays the Fantasy F1 team with the worst points tally, instead of displaying the best. This might be more interesting than actually useful.

    worst team output

    progress interval

    --progressinterval <n>

    Update the analysis progress spinner every nth team that's analysed. The higher the number n, the less frequently the screen is updated and the faster the analysis completes.

    Default: 5 (updates progress spinner for each team that's analysed).

    Verbose

    --verbose

    Enables verbose output.

    Default: false

    Debug

    --debug

    Enables debugging output.

    Default: false

    No-color

    --no-color

    Switches off colour output.

    Version

    --version

    Displays the version number.

    Help

    --help

    Displays the help screen.

    Change Log

    The Change Log can be found here

    Install

    npm i fantasy-f1-analyzer

    DownloadsWeekly Downloads

    10

    Version

    1.4.0

    License

    MIT

    Unpacked Size

    721 kB

    Total Files

    18

    Last publish

    Collaborators

    • mark.murphy