README.md

In gahoo/ross: Aliyun OSS API

Overview

为了在R中方便地调用阿里云OSS，ross对阿里云OSS API进行了三层封装，实现了OSS的大部分功能。 - 原始的OSS API，与阿里官方保持一致。 - wrapper函数，更符合R用户的使用习惯。 - ossutil函数与R6对象，前者提供了类似ossutil的体验，后者提供了面向对象的操作方法。

建议开发者使用wrapper函数或R6对象，普通用户使用ossutil函数或R6对象。ossutil函数更适合交互式操作。

Installation

目前ross没有收录在CRAN中，需要用devtools直接从GitHub安装。

devtools::install_github('gahoo/ross', build_vignettes = TRUE)
library(ross)

查看完整文档。

browseVignettes('ross')

Settings

操作OSS需要AccessKeyId和AccessKeySecret进行签名，在使用ross包之前需要先设置这两个环境变量。

Sys.setenv(
  AccessKeyId="xxxxxxxxxxxxxxxx",
  AccessKeySecret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
)

也可以选择将环境变量写入~/.Renviron文件。

AccessKeyId=xxxxxxxxxxxxxxxx
AccessKeySecret=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Quick Start

# 创建Bucket
oss.mb('oss://ross-test')
# 写入文件
oss.write('oss://ross-test/test.txt', 'test')
# 读取文件
oss.read('oss://ross-test/test.txt')
# 保存对象
oss.saveRDS('oss://ross-test/test.rds', 1:5)
# 读取对象
oss.readRDS('oss://ross-test/test.rds')
# 下载
oss.cp('oss://ross-test/test.txt', '/tmp/')
# 上传
oss.cp('/tmp/test.txt', 'oss://ross-test/test.txt')

wrapper / ossutil / R6

同样的功能可以用三类不同的函数实现，可以挑选习惯的使用。

wrapper函数将常用的OSS功能进行了封装，方便调用。ossutil和R6均基于wrapper函数构建。ossutil函数与官方的ossutil命令行工具使用方法类似，适合交互式的使用模式。此外，ross以Bucket，Obejct等为对象封装了与之相关的大部分功能，诸如lifecycle，logging等关于Bucket的设置更适合用这些R6对象。

# wrapper
createBucket('ross-test')
# ossutil
oss.mb('oss://ross-test')
# R6
b <- Bucket$new('ross-test')
b$create()

gahoo/ross documentation built on May 16, 2019, 5:35 p.m.