From e4cf4f67522890feb0942c8b3e2f5d8809d4f467 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Mon, 5 Apr 2021 20:53:33 +0100 Subject: [PATCH] Update README.md --- gamestonk_terminal/screener/README.md | 53 ++++++++++++++++++++------- 1 file changed, 40 insertions(+), 13 deletions(-) diff --git a/gamestonk_terminal/screener/README.md b/gamestonk_terminal/screener/README.md index b49b0b9d396..bbcc602fc5a 100644 --- a/gamestonk_terminal/screener/README.md +++ b/gamestonk_terminal/screener/README.md @@ -18,6 +18,7 @@ This menu aims to filter stocks based on pre-specified preset filters, and the u * performance information [Finviz] * [technical](#technical) * technical information [Finviz] + * [technical information when oversold (-s) signal](#signal-oversold) * [signals](#signals) * view filter signals (e.g. -s top_gainers) [Finviz] @@ -50,14 +51,15 @@ Set preset from under presets folder. usage: overview [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, -ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. -* -s : Signal type. Defaul: None. When specified (see list available in [signals](#signals)), the preset is disregarded. +* -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. * -l : Limit of stocks to output. Default: 200. * -a : Set order of stocks shown to Ascended. Default: Descended. +overview + ## valuation @@ -65,14 +67,15 @@ ownership, performance, technical. Note that when the signal parameter (-s) is s usage: valuation [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, -ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. -* -s : Signal type. Defaul: None. When specified (see list available in [signals](#signals)), the preset is disregarded. +* -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. * -l : Limit of stocks to output. Default: 200. * -a : Set order of stocks shown to Ascended. Default: Descended. +valuation + ## financial @@ -80,14 +83,15 @@ ownership, performance, technical. Note that when the signal parameter (-s) is s usage: financial [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, -ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. -* -s : Signal type. Defaul: None. When specified (see list available in [signals](#signals)), the preset is disregarded. +* -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. * -l : Limit of stocks to output. Default: 200. * -a : Set order of stocks shown to Ascended. Default: Descended. +financial + ## ownership @@ -95,14 +99,31 @@ ownership, performance, technical. Note that when the signal parameter (-s) is s usage: ownership [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] ``` -Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, -ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] +Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. -* -s : Signal type. Defaul: None. When specified (see list available in [signals](#signals)), the preset is disregarded. +* -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. * -l : Limit of stocks to output. Default: 200. * -a : Set order of stocks shown to Ascended. Default: Descended. +ownership + + +## performance + +```text +usage: performance [-p {template,sexy_year,...}] [-s {top_gainers,top_losers,...}] [-l LIMIT] [-a] +``` + +Prints screener data of the companies that meet the pre-set filtering. The fields shown correspond to the type of function called, i.e.: overview, valuation, financial, ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] + +* -p : Filter presets. Default: one pre-loaded in screener menu. +* -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. +* -l : Limit of stocks to output. Default: 200. +* -a : Set order of stocks shown to Ascended. Default: Descended. + +performance + ## technical @@ -114,10 +135,16 @@ Prints screener data of the companies that meet the pre-set filtering. The field ownership, performance, technical. Note that when the signal parameter (-s) is specified, the preset is disregarded. [Source: Finviz] * -p : Filter presets. Default: one pre-loaded in screener menu. -* -s : Signal type. Defaul: None. When specified (see list available in [signals](#signals)), the preset is disregarded. +* -s : Signal type. Default: None. When specified (see list available in [signals](#signals)), the preset is disregarded. * -l : Limit of stocks to output. Default: 200. * -a : Set order of stocks shown to Ascended. Default: Descended. +technical + +### signal oversold + +technical_oversold flag + ## signals