Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.21 KB

README.md

File metadata and controls

58 lines (39 loc) · 2.21 KB

orderly.sharedrive

Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept. codecov.io R-CMD-check

An orderly1 remote hosted on a shared drive. Either a network share or a synced onedrive.

Installation

remotes::install_github("vimc/orderly.sharedrive")

Usage

Configure your orderly_config.yml as, for example:

remote:
  real:
    driver: orderly.sharedrive::orderly_remote_sharedrive
    args:
      path: ~/path/to/drive

Where

  • path is the path to your shared drive or the name of an environment variable.

If you are working with other people we recommend you use an environment variable with the value set in orderly_envir.yml. To do so, create or add to a file orderly_envir.yml at the root of your orderly project.

SHAREPOINT_PATH: /home/me/path/to/sharepoint/drive

And then in your orderly_config.yml set

remote:
  real:
    driver: orderly.sharedrive::orderly_remote_sharedrive
    args:
      path: $SHAREPOINT_PATH

Add orderly_envir.yml to your gitignore, then each user of your repo can set it as appropriate for their machine.

orderly.sharedrive will store files as archive/<name>/<id> where <name> is the report name and <id> is a zip archive of the report contents. These must be treated as read-only and must not be modified (they do not have a file extension to help this).

With this set up, then orderly1::pull_dependencies, orderly1::pull_archive and orderly1::push_archive will work, and you can use your network or onedrive remote to distribute orderly results within your group.

License

MIT © Imperial College of Science, Technology and Medicine