Skip to content

Commit

Permalink
add README.Rmd so we can build .md from source
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Nov 1, 2023
1 parent 6080a13 commit 9034a34
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 1 deletion.
48 changes: 48 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# sixtyfour

<!-- badges: start -->
[![Project Status: Concept – Not useable, no support, not open to feedback, unstable API.](https://getwilds.github.io/badges/badges/concept.svg)](https://getwilds.github.io/badges/#concept)
[![R-CMD-check](https://github.com/getwilds/sixtyfour/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/getwilds/sixtyfour/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

A science-focused, more humane R interface to AWS.

## Installation

Development version

```{r eval=FALSE}
# install.packages("pak")
pak::pkg_install("getwilds/sixtyfour")
```

This package is not on CRAN (yet)

## sixtyfour high level organization

- `aws_billing`: get AWS billing details
- `aws_bucket*`: manage S3 buckets
- `aws_file_*`: manage files in S3 buckets on AWS
- `aws_user*`: manage users on AWS
- `aws_db*`: interact with AWS databases


## Getting Started

You'll need two AWS secrets and the an AWS region:

```
Sys.setenv(
AWS_ACCESS_KEY_ID = "",
AWS_SECRET_ACCESS_KEY = "",
AWS_REGION = "us-west-2"
)
```

## Setting the interface

The function `sixtyfour::set_s3_interface` makes it easier to toggle between S3 compatible backends; right now only supporting AWS S3 itself and [Minio](https://min.io/).

## Code of Conduct

Please note that the sixtyfour project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ A science-focused, more humane R interface to AWS.

Development version

``` r

```r
# install.packages("pak")
pak::pkg_install("getwilds/sixtyfour")
```
Expand Down

0 comments on commit 9034a34

Please sign in to comment.