ensureServerDirs: Ensure existence of a hierarchy of folders for running a...

View source: R/ensureServerDirs.R

ensureServerDirsR Documentation

Ensure existence of a hierarchy of folders for running a motus data processing server.

Description

This will create, if necessary, a set of folders under the root folders /sgm (for NAS-stored items) and /sgm_hd (for critical databases stored on the local HD).

Usage

ensureServerDirs()

Details

Folder hierarchy includes these: (although check motusConstants.R for a complete list)

  • /sgm/bin - scripts to perform tasks; these will be symlinks to files in this package's scripts folder e.g.: processMessage.py -> /usr/local/lib/R/site-library/motus/scripts/processMessage.py

  • /sgm_hd/cache - cached copy of motus metadata e.g.: motus_meta_db.sqlite

  • /sgm/errors - stack dumps of server errors e.g.: 2016-09-27T02-24-21.885735_dump.rds

  • /sgm/file_repo - repository of raw data files, by receiver

  • /sgm/incoming - where new files or directories are linked from or copied to so that they get processed; the server() function from the motus R package watches this folder for new entries, then processes them

  • /sgm/logs - logfile for each receiver e.g.: SG-4001BBBK2230.log.txt

  • /sgm/plots - summary plots by receiver and tag e.g.: 2016_Motus_Walsingham_hourly_old_new.png

  • /sgm/pub - public files that can be served to anyone ( e.g.: the tag deployment timeline

  • /sgm/recv - one .motus sqlite database per receiver, by serial number e.g.: SG-4001BBBK2230.motus

  • /sgm/recvlog - log files retrieved from receivers; this folder will have a subfolder for each receiver, by serial number, and those folders will have subfolders for each date at which log files were retrieved e.g. /sgm/recvlog/SG-4001BBBK2230/2016-07-30/...

  • /sgm/tags - one .motus sqlite database per tag project, by motus project code e.g.: project_47_tags.motus

  • /sgm/tmp - location for temporary processing directories which we don't want erased on system reboot

Value

returns TRUE if any directories had to be created, FALSE otherwise.

Author(s)

John Brzustowski jbrzusto@REMOVE_THIS_PART_fastmail.fm


MotusWTS/motusServer documentation built on Dec. 3, 2024, 10:47 a.m.