mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 21:42:22 +00:00
775d218891
* Add helper command to filter unix paths and other edge cases * Remove sort argument filtering from parsing * Make --file arg mandatory for loading files * Refactor queue parsing logic * Enable adding controller level input parsing filters * Remove the github repo path hack because it's not needed anymore * Fix typos and line length linting * Update unix path parser to match known extensions * Update oss custom filters to not require space after slash arg * Fix tests and failing linters * Add pre-commit hook to check for reserved arguments validity * Fix tests * Fix finviz compare screener tests * Fix screener test * Fix screener test * Fix float representation in pd dataframe on finviz screener tests * Update test records * Update test records * Remove explicit float formatting in tests * Update tests * Remove prepending file argument * Update long arguments that have lost their short default to file * Update arguments in docs * Update portfolio test data * Fix econometrics/desc throwing error on empty df and fix tests * Update tests * Fix econometrics load autocompletion * Fix portfolio tests giving different results every time * Allow loading openbb scripts from arbitrary path * Fix passing path as a terminal argument * Fix guess game being case sensitive * Silence bandit warning about using pseudo-random generators * Update gov tests * Fix screener sort fields that have forward slash * Make controllers apply custom argument filters on entry Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
1.6 KiB
Vendored
1.6 KiB
Vendored
usage: exe [-f PATH] [-i ROUTINE_ARGS] [-h]
The .openbb scripts offer the ability to automatically run a set of commands in the form of a routine. Furthermore, the scripts can be adapted, and documented, at any moment giving the user full control over the type of analysis you wish to do (and repeat). This can fundamental research, understanding market movements, finding hidden gems and even doing advanced statistical/econometric research.
optional arguments:
-f PATH, --file PATH The path or .openbb file to run. (default: )
-i ROUTINE_ARGS, --input ROUTINE_ARGS
Select multiple inputs to be replaced in the routine and separated by commas. E.g. GME,AMC,BTC-USD (default: None)
-h, --help show this help message (default: False)
An example of a script can be the following (inside a .openbb file):
# Go into the econometrics context
econometrics
# Load the wage_panel dataset and include an alias
load wage_panel -a wp
# Set the MultiIndex, allowing for Panel regressions to be performed
index wp -i nr,year
# Change the type of the year column so it can be included as time effects within the regressions
type wp.year --format category
# Perform a Pooled OLS, Random Effects and Fixed Effects estimation
panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year
panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year -r re
panel -d wp.lwage -i wp.expersq,wp.union,wp.married,wp.year -r fe
# Compare the results obtained from these regressions
compare