Learn R Programming

⚠️There's a newer version (0.2.9) of this package.Take me there.

osfr: R Interface to the Open Science Framework

The R package osfr interfaces with the Open Science Framework (OSF) to both get information from the OSF and push information to the OSF. If you are looking for a Python client see osf-cli.

To install, you currently have to have devtools installed, considering the package is not yet available on CRAN. When it is available on CRAN, we will celebrate here :palm_tree: Install and login is as follows from R:

devtools::install_github('CenterForOpenScience/osfr')

login()

Considering this software is still very much in development, please don't use it to build anything that requires stability. Code might very well break still throughout the development process. When v1.0.0 comes around, that's when it is reasonable to start building on this reliably (that's when it will also be on CRAN).

Contributing

Contributions are definitely welcome! There have been some great uninvited contributions, that have made the project much better. If you're looking for ways to contribute, the issues is always a good place to start. If you notice a typo, also please submit a PR! And most of all, this project should not only be for those that control the ephemeral skill of using git so if you want to contribute you can also always e-mail to brian.g.richards@gmail.com.

Note that for this project there is a clear Code of Conduct and that in contributing to the project you are expected to keep to these guidelines. If you are contributing to the project, please also keep an eye out for problems and don't turn your back on harassment, inappropriate comments etc.

Copy Link

Version

Install

install.packages('osfr')

Monthly Downloads

1,177

Version

0.1.1

License

MIT + file LICENSE

Maintainer

Chris Hartgerink

Last Published

September 26th, 2022

Functions in osfr (0.1.1)

construct_link_files

Construct a Waterbutler API link with proper base
osfr

osfr: A package for interacting with OSF from the Center for Open Science.
path_file

Get file download link for the latest version of a file (for direct reading)
create_folder

Create a new folder in an OSF project.
comment_osf

Comment on a project on OSF
update_project

Update an OSF project
construct_link

Construct an API link with proper base
create_project

Create a project on OSF
download_files

Download files from OSF
get_config

Create authorization config
upload_files

Upload a file to OSF (both new and revised)
get_files_info

Get file information
get_nodes

Retrieve nodes associated with id
process_json

Function to parse API call
process_pagination

Process Pagination
logged_in

Identify whether user is logged in
login

Login to the OSF
process_type

Identify type of endpoint for id
auth

Authentication function
clone_project

Clone OSF project to desktop
process_waterbutler

Materialize Waterbutler URL
search_users

Search OSF users
update_component

Update a component on the OSF
upload_zip

Zip up a directory and upload the zip to OSF (both new and revised)
recurse_node

Function to crawl through OSF project
rm_space

Function to correct link into something parsable
get_users

Return information on an OSF user
view_project

View an OSF project on osf.io
is_valid_osf_id

Check OSF id
logout

Logout of the OSF
move_files

Move (and copy) files on OSF
delete_component

Empty out a component and delete it
upload_new_files

Upload a new file to OSF.
upload_revised_files

Upload a revised file to OSF
delete_files

Delete a file based on OSF id
process_category

Processing whether a category is valid
process_file_id

Processing a file id to waterbutler
search_nodes

Search OSF nodes
search_osf

Searching the OSF
delete_folder

Delete a folder on OSF
create_component

Create a component within a project
delete_project

Delete a project from OSF