-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
63 lines (45 loc) · 1.88 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
out.width = "100%",
fig.path = "inst/extdata/img/README-"
)
library(tibble)
```
## odc-sits - SITS-based R Client Library for Open Data Cube
<!-- badges: start -->
[![Software
License](https://img.shields.io/badge/license-MIT-green)](https://github.com/brazil-data-cube/odc-sits/blob/master/LICENSE)
[![Software Life
Cycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![Join us at
Discord](https://img.shields.io/discord/689541907621085198?logo=discord&logoColor=ffffff&color=7389D8)](https://discord.com/channels/689541907621085198#)
<!-- badges: end -->
[Open Data Cube](https://www.opendatacube.org/) is a system designed to manage Spatio-temporal Earth Observation Data Cubes.
The `odc-sits` package is an experimental R Client for the Open Data Cube ecosystem. The Data Cube representation performed by `odc-sits` is based on the [SITS package](https://github.com/e-sensing/sits). This pairing gives the possibility of using ODC data products in Satellite Image Time Series Classification.
## Installation
To install the development version of `odc-sits`, run the following commands:
``` {R, eval=FALSE}
# load necessary libraries
library(devtools)
devtools::install_github("brazil-data-cube/odc-sits")
```
Importing `odc-sits` package:
``` {R, echo=TRUE, warning=FALSE, message=FALSE}
library(odcsits)
```
## Usage
`odc-sits` implements the following WLTS operations:
```{R, echo=FALSE}
tribble(
~"Operation", ~"`odc-sits` functions",
"`List ODC Products Available`", "`odc_products`",
"`Search ODC Datasets`", "`odc_search`",
"`Create a ODC Data Cube`", "`odc_cube`"
) %>% as.data.frame() %>% knitr::kable(format = "markdown")
```