diff --git a/README.md b/README.md new file mode 100644 index 0000000..31e250d --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ + +## Systematic Investor Toolbox (SIT) + + 1. Systematic Investor Toolbox is a collection of tools that I use in my investment research. I will demonstrate and document various uses of toolbox in the Systematic Investor blog at + + 2. For more information please visit my blog at www.SystematicInvestor.wordpress.com or drop me a line at TheSystematicInvestor at gmail + + 3. www.SystematicInvestor.wordpress.com and systematicinvestor.github.io + + +
+
+ +## License + +

+ +This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. + +# + +Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: + +# + +

+ + 1. The origin of this software must not be misrepresented; you must not + 2. claim that you wrote the original software. If you use this software + 3. in a product, an acknowledgment in the product documentation would be + 4. appreciated but is not required. + 5. Altered source versions must be plainly marked as such, and must not be + 7. misrepresented as being the original software. + 8. is notice may not be removed or altered from any source distribution. + +
+
+ +### Example Usage: + +- 1. install.packages('curl', repos = 'http://cran.r-project.org') + +- 1. Install Systematic Investor Toolbox (SIT) package +- 1. github.com/systematicinvestor/SIT + + +- 1. please first install SIT.date +- 1. devtools::install_github('systematicinvestor/SIT.date') +# +- 1. library(curl) +- 1. curl_download('https://github.com/systematicinvestor/SIT/raw/master/SIT.tar.gz', 'sit',mode = 'wb',quiet=T) +- 1. install.packages('sit', repos = NULL, type='source') + +# + +- 1. Example Usage: library(SIT) +- 1. Run plota test +- 2. plota.test() + +
+