Skip to content

Commit

Permalink
renaming the readme to indiGO_Tutorial1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hetzerj committed Nov 4, 2024
1 parent 50bc99b commit 41b150a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 4 deletions.
20 changes: 20 additions & 0 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,30 @@



<<<<<<< HEAD
<section id="how-to-use-the-indigo-r-package" class="level1">
<h1>How to use: The indiGO R Package</h1>
<p>This repository contains a Quarto project that demonstrates the usage of the <strong>IA (Indicator Analyses)</strong> R package. The <strong>IA</strong> package can be found in the <a href="https://github.com/hetzerj/IA">hetzerj/IA</a> repository.</p>
=======
<section id="tutorial-1.0-how-to-use-the-indigo-r-package" class="level1">
<h1>Tutorial 1.0: How to use the indiGO R Package</h1>
<p>This repository contains a Quarto project that demonstrates the usage of the he <strong>indiGO (Indicators in Generalized Outputs)</strong> R-package which is designed to analyze and display global indicators of the status and trends in nature in a generalized and systematic way. The indiGO package can be found in the <a href="https://github.com/hetzerj/indiGO">indiGO R package repository</a>.</p>
>>>>>>> bac8815 (renaming the readme files to indiGO_Tutorial1.0)
<section id="overview" class="level2">
<h2 class="anchored" data-anchor-id="overview">Overview</h2>
<p>The indiGO R-package provides an open-access framework that enables users to access annually and globally aggregated indicators as described in the <a href="https://doi.org/10.5281/zenodo.3831673">first Global Assessment Report on Biodiversity and Ecosystem Services</a> of the Intergovernmental Science-Policy Platform on Biodiversity and Ecosystem Services (IPBES, 2019). It follows the standardization of indicators outlined in the supplemental material of the Global Assessment Report, <a href="https://doi.org/10.5281/zenodo.3832005">Chapter 2.2: Status and Trends – Nature</a>.</p>
<p>The package provides a flexible framework for handling a wide variety of indicators, not limited to a specific region, ecosystem, or time period. The generalized outputs are broad and adaptable, allowing users to apply them to various generalized data sets or indicator types across global or regional scales. Additionally, indiGO allows users to include their own data, enabling local data integration for customized indicator analysis.</p>
<ul>
<<<<<<< HEAD
<li><strong>Available Indicators</strong>: Lists all the indicators provided by the <strong>IA</strong> package.</li>
=======
<li><strong>Available Indicators</strong>: Lists all the indicators provided by the indiGO R package.</li>
>>>>>>> bac8815 (renaming the readme files to indiGO_Tutorial1.0)
<li><strong>Function Demonstrations</strong>: Shows how the core functions of the package work, using practical examples.</li>
<li><strong>Plotting Figures</strong>: Provides instructions and examples for visualizing the indicators using the package’s functions.</li>
</ul>
</section>
<<<<<<< HEAD
<section id="key-features" class="level2">
<h2 class="anchored" data-anchor-id="key-features">Key Features</h2>
<ul>
Expand All @@ -109,6 +120,15 @@ <h2 class="anchored" data-anchor-id="how-to-access-the-quarto-project">How to Ac
<section id="download-and-install-the-indigo-r-package" class="level2">
<h2 class="anchored" data-anchor-id="download-and-install-the-indigo-r-package">Download and Install the indiGO R Package</h2>
<p>You can download and install the <strong>indiGO</strong> R package directly from the <a href="https://github.com/hetzerj/indiGO">hetzerj/IA</a> GitHub repository using the following commands in R:</p>
=======
<section id="how-to-access-the-tutorial" class="level2">
<h2 class="anchored" data-anchor-id="how-to-access-the-tutorial">How to Access the Tutorial</h2>
<p>The Tutorial is rendered as a website using GitHub Pages. You can access the live version of the documentation <a href="https://hetzerj.github.io/IA_quarto/">here</a>.</p>
</section>
<section id="download-and-install-the-indigo-r-package" class="level2">
<h2 class="anchored" data-anchor-id="download-and-install-the-indigo-r-package">Download and Install the indiGO R Package</h2>
<p>You can download and install the <strong>indiGO</strong> R package directly from the <a href="https://github.com/hetzerj/indiGO">indiGO R package repository</a> using the following commands in R:</p>
>>>>>>> bac8815 (renaming the readme files to indiGO_Tutorial1.0)
<div class="sourceCode" id="cb1"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># Install devtools if not already installed</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">install.packages</span>(<span class="st">"devtools"</span>)</span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a></span>
Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
# How to use: The indiGO R Package
# Tutorial 1.0: How to use the indiGO R Package

This repository contains a Quarto project that demonstrates the usage of the **IA (Indicator Analyses)** R package. The **IA** package can be found in the [hetzerj/IA](https://github.com/hetzerj/IA) repository.
This repository contains a Quarto project that demonstrates the usage of the he **indiGO (Indicators in Generalized Outputs)** R-package which is designed to analyze and display global indicators of the status and trends in nature in a generalized and systematic way. The indiGO package can be found in the [indiGO R package repository](https://github.com/hetzerj/indiGO).

## Overview

The indiGO R-package provides an open-access framework that enables users to access annually and globally aggregated indicators as described in the [first Global Assessment Report on Biodiversity and Ecosystem Services](https://doi.org/10.5281/zenodo.3831673) of the Intergovernmental Science-Policy Platform on Biodiversity and Ecosystem Services (IPBES, 2019). It follows the standardization of indicators outlined in the supplemental material of the Global Assessment Report, [Chapter 2.2: Status and Trends – Nature](https://doi.org/10.5281/zenodo.3832005).

The package provides a flexible framework for handling a wide variety of indicators, not limited to a specific region, ecosystem, or time period. The generalized outputs are broad and adaptable, allowing users to apply them to various generalized data sets or indicator types across global or regional scales. Additionally, indiGO allows users to include their own data, enabling local data integration for customized indicator analysis.

<<<<<<< HEAD
- **Available Indicators**: Lists all the indicators provided by the **IA** package.
=======
- **Available Indicators**: Lists all the indicators provided by the indiGO R package.
>>>>>>> bac8815 (renaming the readme files to indiGO_Tutorial1.0)
- **Function Demonstrations**: Shows how the core functions of the package work, using practical examples.
- **Plotting Figures**: Provides instructions and examples for visualizing the indicators using the package's functions.

## Key Features
## How to Access the Tutorial

<<<<<<< HEAD
- Displays all available indicators in the package.
- Demonstrates how to apply various functions within the package to analyze indicators.
- Shows how to generate and customize plots for visualizing indicator data.
Expand All @@ -22,10 +27,13 @@ The package provides a flexible framework for handling a wide variety of indicat
## How to Access the Quarto Project

The Quarto project is rendered as a website using GitHub Pages. You can access the live version of the documentation [here](https://hetzerj.github.io/IA_quarto/).
=======
The Tutorial is rendered as a website using GitHub Pages. You can access the live version of the documentation [here](https://hetzerj.github.io/IA_quarto/).
>>>>>>> bac8815 (renaming the readme files to indiGO_Tutorial1.0)
## Download and Install the indiGO R Package

You can download and install the **indiGO** R package directly from the [hetzerj/IA](https://github.com/hetzerj/indiGO) GitHub repository using the following commands in R:
You can download and install the **indiGO** R package directly from the [indiGO R package repository](https://github.com/hetzerj/indiGO) using the following commands in R:

``` r
# Install devtools if not already installed
Expand Down

0 comments on commit 41b150a

Please sign in to comment.