Skip to content

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

License

Notifications You must be signed in to change notification settings

sharisochs/arcticdatautils

 
 

Repository files navigation

arcticadatautils

Travis build status

The articadatautils package contains code for doing lots of useful stuff that's too specific for the dataone package:

  • Inserting large numbers of files into a Metacat Member Node
  • High-level dataone 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

I recommend installing from the latest release (aka tag) instead of from master. Install the latest release with the remotes package:

remotes::install_github("nceas/arcticdatautils@*release")

If you're feeling adventurous, you can install from the bleeding edge:

remotes::install_github("nceas/arcticdatautils")

Contributing

  • Please submit suggestions or bugs as 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

  • Please submit bugs or other comments as 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:

devtools::test()

If you do want to run integration tests

  1. Visit 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:
options(dataone_test_token = "{YOUR_TOKEN_HERE}") # <- Modify this line
devtools::test()

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • R 87.3%
  • XSLT 12.7%