foxerlee / tworavens-backend Goto Github PK

TwoRavens is a system of interlocking statistical tools for data exploration, analysis, and meta-analysis. The first to be released is an interface for quantitative analysis, that allows users at all levels of statistical expertise to explore their data, describe their substantive understanding of the data, and appropriately construct statistical models. This integrates with Dataverse (Project|GitHub) and Zelig (Project|GitHub), through a portable, lightweight, browser-based and gesture-driven interface, allowing users to run statistical models available in Zelig on data archived in Dataverse.

Project page and publications available at: http://2ra.vn

To demo TwoRavens using replication data from Fearon and Laitin's 2003 article, Ethnicity, Insurgency, and Civil War: https://beta.dataverse.org/dataexplore/gui.html?dfId=37&

The data that TwoRavens used all comes from Dataverse. So we are trying to develop an independent backend, which can handle, analyze the origin data, and send the data to TwoRavens.

• Java SE Development Kit 8
• R 3.2.2 or higher
• R packages
  • Rserve 1.7.3 or higher
  • Other R packages

• get the project from github

git clone https://github.com/FoxerLee/TwoRavens-Backend.git

Open the pom.xml file with IntelliJ IDEA. It will automatically import the required dependencies.

$ cd TwoRavens-Backend
$ mvn clean package

You can also use IDEA to create jar file or war file.

$ java -jar  filename.jar

If you build war file, you can simply put the war file into tomcat.

We implemented and packaged 5 http interfaces, which were used both for users and TwoRavens. Here you can see a simple description about these interfaces. More detail information can be found in High-level Design document.

create/xml?name={test}

This interface can create .xml file according to the .tab file.

create/prep?name={test}

This interface can create .prep file according to the .tab file.

download/xml?name={test}

This interface candownload .xml file.

download/prep?name={test}

This interface candownload .prep file.

download/tab?name={test}

This interface candownload .tab file.

main
├── java (Spring boot code about create or download files)
│   └── com
│       └── monetware 
│           └── demo
│               ├── DemoApplication.java
│               ├── controller (Create and Download implementation)
│               │   ├── CreationController.java
│               │   ├── DownLoadController.java
│               │   └── UploadController.java
│               ├── prep (Create .prep file)
│               │   ├── RemoteDataFrameService.java
│               │   ├── preprocess.R
│               │   └── scripts
│               │       └── dataverse_r_functions.R
│               ├── variable (Some useful Variable)
│               │   └── root.java
│               └── xml (Create .xml file)
│                   ├── CreateXML.java
│                   ├── SummaryStatCalculator.java
│                   └── WriteXML.java
└── resources (Store files)
    ├── application.properties
    ├── index.html
    ├── preprocess.R
    └── static (Store created files)
        └── files
            ├── prep
            │   └── test.prep
            ├── tab
            │   └── test.tab
            └── xml
                └── test-ddi.xml

resources: Store created files like xml, prep and tab file.

• static: Store created files

java: Spring boot code about create or download files

• controller: Create and Download implementation
• prep: Create .prep file
• xml: Create .xml file
• variable: Some useful Variable