https://github.com/nceas/arcticdatautils

Utility functions in R for processing data for the Arctic Data Center
https://github.com/nceas/arcticdatautils

Last synced: 8 months ago
JSON representation

Utility functions in R for processing data for the Arctic Data Center

• Host: GitHub
• URL: https://github.com/nceas/arcticdatautils
• Owner: NCEAS
• License: apache-2.0
• Created: 2016-05-18T22:06:41.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-07-09T17:44:57.000Z (over 1 year ago)
• Last Synced: 2024-07-09T22:21:30.997Z (over 1 year ago)
• Language: R
• Homepage: https://nceas.github.io/arcticdatautils/
• Size: 1.46 MB
• Stars: 10
• Watchers: 8
• Forks: 20
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# arcticdatautils

[![R build status](https://github.com/NCEAS/arcticdatautils/workflows/R-CMD-check/badge.svg)](https://github.com/NCEAS/arcticdatautils/actions)

[![Travis build status](https://travis-ci.org/NCEAS/arcticdatautils.svg?branch=master)](https://travis-ci.org/NCEAS/arcticdatautils)

The `arcticdatautils` package contains code for doing lots of useful stuff that's too specific for the [dataone](https://github.com/DataONEorg/rdataone) package:

- Inserting large numbers of files into a Metacat Member Node

- High-level [dataone](https://github.com/DataONEorg/rdataone) wrappers for working with Objects and Data Packages that streamline Arctic Data Center operations

Note: The package is intended to be used by NCEAS staff and may not make much sense to others.

## Installing

To install the latest version of this package we recommend installing from Github:

```r

remotes::install_github("nceas/arcticdatautils@main")

```

## Contributing

- Please submit suggestions or bugs as [Issues](https://github.com/NCEAS/arcticdatautils/issues).

- Pull Requestss (PR) should target the `master` branch

- Before submitting a PR, please:

  - Re-document and commit any `*.Rd` file changes

    > `devtools::document()`

  - R CMD CHECK and fix any issues related to your changes

    > `devtools::check()`

  - Run the tests and make sure they all pass

    > `devtools::test()`

## Support

- Explore the pkgdown site for documentation: https://nceas.github.io/arcticdatautils/

- Please submit bugs or other comments as [Issues](https://github.com/NCEAS/arcticdatautils/issues)

- Maintainers of the package are @jeanetteclark and @jagoldstein

## Testing

Note: The test suite contains a set of tests that call out to a remote server and whether or not these tests are run depends on whether `is_token_set()` returns true which just checks whether the `dataone_test_token` option is set.

If you don't want to run integration tests:

```r

devtools::test()

```

If you *do* want to run integration tests

1. Visit [https://test.arcticdata.io](https://test.arcticdata.io)

2. Log in

3. Navigate to My Profile > Settings > Authentication Token

4. Click the "Token for DataONE R" tab

5. Copy the code snippet

6. Modify the first line in the snippet below:

```r

options(dataone_test_token = "{YOUR_TOKEN_HERE}") # <- Modify this line

devtools::test()

```