Close Menu

sznaltmetric


Introduction

Welcome to the complete guide on how to use and implement the sznAltmetric framework. In this documentation, you will find everything you need to know about this powerful tool for analyzing and visualizing Altmetric data.

Installation

To get started with sznAltmetric, follow these steps:

  1. Download the latest version of sznAltmetric from the official website or GitHub repository.
  2. Extract the downloaded package to your desired location.
  3. Open your project in Xcode.
  4. Drag and drop the sznAltmetric framework into your Xcode project’s file navigator.
  5. In the Xcode project settings, select your app target, and go to the “General” tab.
  6. Scroll down to the “Frameworks, Libraries, and Embedded Content” section.
  7. Click the “+” button and select sznAltmetric.framework from the list.
  8. Make sure the framework is set to “Embed & Sign”.

Usage

Once you have successfully installed sznAltmetric, you can start using it in your project. Here’s an overview of the main features and functionalities:

1. Configuration

Before you can retrieve Altmetric data, you need to configure sznAltmetric with your API credentials. To do this, follow these steps:

  1. Import the sznAltmetric module into your source file:
    2. [import sznAltmetric]
  2. Create a configuration instance:
    3. let config = sznAltmetricConfig(apiKey: "YOUR_API_KEY_HERE")
  3. Set the configuration with your Altmetric API key:
    4. sznAltmetric.shared.configure(with: config)

2. Retrieving Altmetric Data

With sznAltmetric configured, you can now fetch Altmetric data for a specific research output. Use the following code snippet as an example:

sznAltmetric.shared.fetchData(forDOI: "10.1234/abcd1234") { result in
    switch result {
    case .success(let data):
        // Handle successful data retrieval
        print(data)
    case .failure(let error):
        // Handle error
        print("Error: \(error.localizedDescription)")
    }
}

3. Data Visualization

sznAltmetric allows you to easily visualize Altmetric data using various chart types. Here’s an example of how to create a bar chart for Altmetric citation counts:

let altmetricData = sznAltmetricData() // Assume you have retrieved Altmetric data
let barChartView = sznAltmetricChartView.createBarChart(data: altmetricData.citationCounts)
barChartView.frame = CGRect(x: 0, y: 0, width: 300, height: 200)

// Add the chart view to your desired view
view.addSubview(barChartView)

Additional Resources

For more information and detailed explanations, refer to the following resources:

With this guide, you are now equipped with the knowledge to successfully implement and utilize sznAltmetric in your projects. Happy coding!