Skip to content

Commit

Permalink
website
Browse files Browse the repository at this point in the history
  • Loading branch information
oousmane committed Jun 12, 2024
1 parent 1e197b2 commit 5f2907b
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 22 deletions.
11 changes: 6 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,20 @@ knitr::opts_chunk$set(
# oscarr

<!-- badges: start -->
<!-- badges: end -->

The goal of `oscarr` is to provide an R wrapper to `pyoscar` python module that provide an easy access to WMO OSCAR REST API. In other words, the package `oscarr` brings pyoscar to R Community.
<!-- badges: end -->

The goal of `oscarr` is to provide an R wrapper to [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") python module that provide an easy access to WMO OSCAR REST API. In other words, the package `oscarr` brings [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") to R Community.

## Installation
# Installation

You can install the development version of oscarr from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("oousmane/oscarr")
```

The following code set up an virtual environment for python dependencies

``` r
Expand All @@ -41,7 +42,8 @@ reticulate::use_virtualenv(my_env) # force reticulate to use my_env
# install pyoscar in environment
oscarr::install_pyoscar(my_env)
```
## Example

# Example

This is a basic example which shows you how to use `oscarr`:

Expand All @@ -62,4 +64,3 @@ You can add further constrains to the query
## Add further constrains to station query
get_stations(program = "GBON",country = "BFA", station_type = "landFixed")
```

13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# oscarr

<!-- badges: start -->

<!-- badges: end -->

The goal of `oscarr` is to provide an R wrapper to `pyoscar` python
module that provide an easy access to WMO OSCAR REST API. In other
words, the package `oscarr` brings pyoscar to R Community.
The goal of `oscarr` is to provide an R wrapper to [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") python module that provide an easy access to WMO OSCAR REST API. In other words, the package `oscarr` brings [pyoscar](https://github.com/wmo-cop/pyoscar "https://github.com/wmo-cop/pyoscar") to R Community.

## Installation
# Installation

You can install the development version of oscarr from
[GitHub](https://github.com/) with:
You can install the development version of oscarr from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
Expand All @@ -33,7 +30,7 @@ reticulate::use_virtualenv(my_env) # force reticulate to use my_env
oscarr::install_pyoscar(my_env)
```

## Example
# Example

This is a basic example which shows you how to use `oscarr`:

Expand Down
17 changes: 9 additions & 8 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ pandoc: 3.1.11
pkgdown: 2.0.9
pkgdown_sha: ~
articles: {}
last_built: 2024-06-12T14:28Z
last_built: 2024-06-12T15:25Z
urls:
reference: https://oousmane.github.io/oscarr/reference
article: https://oousmane.github.io/oscarr/articles
Expand Down

0 comments on commit 5f2907b

Please sign in to comment.