Metadata-Version: 2.1
Name: factanal
Version: 0.1.2
Summary: A python wrapper for the R function factanal.
Home-page: https://github.com/kjul/factanalpy
Author: Julian Kunschke
Author-email: juliankunschke@yahoo.de
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Requires-Dist: rpy2

### Factanal

Python wrapper replicating the known factor analysis output from the factanal R function. 
The only supported input is a pandas data frame. Formulas as input are currently 
not supported. A covariance matrix is always computed from the input data frame. 
Setting control variables for maximum likelihood estimation is currently not 
supported.


Further information on R's factanal function for factor analysis: https://www.rdocumentation.org/packages/stats/versions/3.6.2/topics/factanal

More information on the factanal output and examples: 
https://data.library.virginia.edu/getting-started-with-factor-analysis/


#### Example

```
import pandas as pd
from wrapper.factanal import factanal

pdf = pd.DataFrame({"v1": [1,1,1,1,1,1,1,1,1,1,3,3,3,3,3,4,5,6],
                   "v2": [1,2,1,1,1,1,2,1,2,1,3,4,3,3,3,4,6,5],
                   "v3": [3,3,3,3,3,1,1,1,1,1,1,1,1,1,1,5,4,6],
                   "v4": [3,3,4,3,3,1,1,2,1,1,1,1,2,1,1,5,6,4],
                   "v5": [1,1,1,1,1,3,3,3,3,22,1,1,1,322,1,6,4,5],
                   "v6": [1,1,2,1,1,3,3,3,3,22,1,1,1,322,1,6,4,5],
                   "v7": [1,1,4,1,1,3,3,3,3,3,1,2,1,1,1,6,4,5],
                   "v8": [1,1,5,2,1,3,3,3,4,3,1,2,1,2,1,6,5,4]})

fa_res = factanal(pdf, factors=3, scores='regression', rotation='varimax', verbose=True, return_dict=True)

print("Regression scores:")
print(pd.DataFrame(fa_res["scores"]))

```


#### Installation

```pip install factanal```

#### Dependencies
The only dependency is the rpy2 library. 

In addition to that, R must be installed on your system and accessible to rpy2.

More information on rpy2: https://rpy2.github.io/doc/latest/html/index.html

Download R here: https://www.r-project.org/

#### Misc
Factanal for python is MIT licensed.




