inspectScicloud: Summarize the result of scicloud analysis

In LisaGotzian/scicloud: Cluster and Network Word Analysis of Scientific Papers

Description

The last function to be called to perform analysis in scicloud. It takes the result of scicloudAnalysis and returns a summary of the cluster analysis.

Usage

inspectScicloud(scicloudAnalysis)

Arguments

scicloudAnalysis

the result of scicloudAnalysis

Value

A summary of the analysis is printed into the console. It gives insights into the total number of papers and words used. If the method was hclust, the returned object contains:

• paperCluster: a paper-cluster table. Each paper belongs to one cluster. Use View(scicloudSpecs$paperCluster) to see which paper belongs to which cluster.

• IndVal: a words-cluster table. Words do not belong to one single cluster. An indicator species analysis shows how representative each word is for each cluster. Use View(scicloudSpecs$IndVal) to view the results of the indicator species analysis.

• excludedPapers: the excluded papers. Use View(scicloudSpecs$excludedPapers) to see which papers have been excluded, possibly because of a PDF error.

• representativePapers: the most representative papers. Use View(scicloudSpecs$representativePapers) to see which papers are the most representative ones, weighted with the indicator species values of the words in the paper.

• metaMatrix: matrix with metadata of the papers. Use View(scicloudSpecs$metaMatrix) to view the original metaMatrix (without full texts, so it's safe to open).

Author(s)

Creator of the scicloud workflow: Henrik von Wehrden, [e-mail]

Code by: Lisa Gotzian, [e-mail]

First version of scicloud: Matthias Nachtmann, [e-mail]

See Also

Other scicloud functions: createScicloudList(), deleteRDS(), runAnalysis(), searchScopus()

Examples

## Not run: 

### Workflow of performing analysis using scicloud
myAPIKey <- "YOUR_API_KEY"
# retrieving data from PDFs and Scorpus website using API
scicloudList <- createScicloudList(myAPIKey = myAPIKey)

# Run the analysis with a specified no. of cluster
scicloudAnalysis <- runAnalysis(scicloudList = scicloudList, numberOfClusters = 4)

# Generate a summary of the analysis
scicloudSpecs <- inspectScicloud(scicloudAnalysis)

## End(Not run)

LisaGotzian/scicloud documentation built on March 29, 2021, 5:52 a.m.