search

SWS-Methodology / Standards

Repository containing SWS related standards
0 stars 0 forks source link

explain setup and purpose of R_SWS_SHARE_PATH environment variable #15

Open bowerth opened 8 years ago

bowerth commented 8 years ago

explain setup and purpose of R_SWS_SHARE_PATH environment variable

$ grep -rl R_SWS_SHARE_PATH faoswsFood/foodModule.R faoswsFood/R/getCommodityClassification.R faoswsFood/sandbox/adhocCommoditiesFood.R faoswsIndustrial/industrialModule.R faoswsIndustrial/R/getCountryCode.R faoswsIndustrial/sandbox/analyseEuroStatData.R faoswsIndustrial/sandbox/analysisIndUse.R faoswsIndustrial/sandbox/comparisonsBetween2Datasets.R faoswsIndustrial/sandbox/descriptionEuroStat.Rmd faoswsIndustrial/sandbox/usdaCodeMap.R faoswsIndustrial/vignettes/analysisIndustrialUse.Rmd faoswsModules/inst/sample_main.R faoswsModules/inst/sample_main_ensure.R faoswsProduction/dataRequirementTest.R faoswsProduction/man/getAnimalMeatMapping.Rd faoswsProduction/modules/balance_production_identity/main.R faoswsProduction/modules/balance_production_identity/README.Rmd faoswsProduction/modules/build_imputed_dataset/main.R faoswsProduction/modules/fill_imputation/main.R faoswsProduction/modules/impute_livestock/main.R faoswsProduction/modules/impute_livestock/README.Rmd faoswsProduction/modules/production_input_validation/main.R faoswsProduction/R/getAnimalMeatMapping.R faoswsProduction/R/getMainKey.R faoswsProduction/sandbox/old_modules/buildModel.R faoswsProduction/sandbox/old_modules/imputeModel.R faoswsProduction/sandbox/old_modules/impute_slaughtered/main.R faoswsProduction/sandbox/old_modules/impute_slaughtered/README.Rmd faoswsProduction/sandbox/old_modules/productionImputationModule.R faoswsProduction/sandbox/old_modules/synchronise_slaughtered/main.R faoswsProduction/sandbox/percentOfficialData.R faoswsStandardization/documentation/Old_code_and_documentation/reconstructed_tree_cpc/buildStandardizationTree.R faoswsStandardization/man/elementCodesToNames.Rd faoswsStandardization/man/elementNamesToCodes.Rd faoswsStandardization/modules/pullDataToSUA/pullDataToSUA.R faoswsStandardization/modules/standardization/standardization.R faoswsStandardization/R/elementCodesToNames.R faoswsStandardization/R/elementNamesToCodes.R faoswsStandardization/vignettes/faoswsStandardization.Rnw faoswsStock/modules/stockModule.R faoswsStock/R/getStockData.R faoswsStock/sandbox/oldVersion/buildModel.R faoswsStock/sandbox/oldVersion/predictModel.R faoswsStock/sandbox/oldVersion/predictModel_testPreds.R faoswsStock/sandbox/oldVersion/vignettes/dataSourcesStock-knitr.Rnw faoswsStock/sandbox/oldVersion/vignettes/faoswsStock-knitr.Rnw faoswsTourist/newTouristModule.R faoswsTourist/R/getCommodityClassification.R faoswsTourist/vignettes/testingTouristModule.Rmd Standards/OrangeBook/examples/generateStockData.R

sebastian-c commented 8 years ago

Just to leave a quick explanation - It's the location of the share drive for that server.

Sometimes you'll need to access files on the share drive. Say, if you're writing some model objects or some other kind of object that cannot be written to a table. You can write to the SWS Share drive. There exists a variable on the server R_SWS_SHARE_PATH which gives the location of this drive.

What to do in code

This variable is accessed on the SWS by using R_SWS_SHARE_PATH <- Sys.getenv("R_SWS_SHARE_PATH"). In your local scripts, you should have this before your CheckDebug block. Within your CheckDebug block, you should define it (i.e. overwrite it) with the location to access this drive from your local machine. This path should be stored in the sws.yml file.