Skip to content

arcedfold is a Stata command that creates specific folder structures for projects.

License

Notifications You must be signed in to change notification settings

ARCED-Foundation/arcedfold

Repository files navigation

🧿 Overview

arcedfold is a Stata command that creates specific folder structures for ARCED's projects. This can be used at the very begining of a project, or to archieve files after completing a project.

arcedsubfold subcommand can be used to create the dataflow in an existing folder structure. The folder structure must have the same structure as generated by arcedfold.

arcedfold uses veracrypt for folder encryption. Download veracrypt and install in your computer if you want to use encryption as part of your dataflow. You also need to download and install SurveyCTO Desktop for manual data download, if you opt for it.

🗃️ Versions

Current version

📝 V3: April 2023 - GitHub repo

Previous versions

📝 V2: November 2022 - GitHub repo

📝 V1: April 2018

⚙️ Installation

* arcedfold can be installed from github

net install arcedfold, all replace ///
	from("https://raw.githubusercontent.com/ARCED-Foundation/arcedfold/master")

help arcedfold

🔧 Syntax

arcedfold foldername, path() [options]

arcedsubfold foldername, path() [options]

Write desired folder name in place of foldername. Write the full path of the directory in path() where you want the folder structure to be created.

🪛 Options

path specifies the path where the folders should be created

rounds sepcifies the list of folders to be created inside the 02_DataWork folder. If surveys not specified, the dataflow will be created inside each rounds.

surveys sepcifies the list of folders to be created inside each of the rounds folder. If rounds not specified, the list of folders will be created inside 02_DataFlow folder and dataflow will be created inside each surveys.

final sepcifies that the folders already exist and to create the file list. Not valid for Not valid for arcedsubfold subcommand.

author Your name and affiliation

email Your email address


💡 If no round as well as no survey is specified, dataflow will be created inside 02_DataWork folder.

📁 Folder tree

01_Admin
  |-- 01_Management
	|-- 01_Design
	|-- 02_Project_log
	|-- 03_Gantt_Chart
	|-- 04_Hiring_and_Onboarding
  |-- 02_Funding
	|-- 01_Proposal
	|-- 02_Agreement
	|-- 03_Reporting
	|-- 04_Invoice
	|-- 05_Deliverables
  |-- 03_Budget
  |-- 04_IRB
	|-- 01_Applications
	|-- 02_Amendments
	|-- 03_Approvals
	|-- 04_Certificates
  |-- 05_Communications
	|-- 01_Letters_and_Permissions
	|-- 02_Email
	|-- 03_Reports_and_Presentations
	|-- 04_Outreach 
	|-- 05_Meeting_Minutes 
02_DataFlow
  |-- Round
	|-- Survey
		|-- 01_Instruments
			|-- 01_Paper
			|-- 02_XLSForm
				|-- 01_Attachments
		|-- 02_Codes
			|-- 01_Ado
		|-- 03_Data
			|-- 01_Samples
			|-- 02_Raw
			|-- 03_Corrections
			|-- 04_Intermediate
			|-- 05_Clean
		|-- 04_Output
			|-- 01_Logs
			|-- 02_Checks
			|-- 03_Analysis
				|-- 01_Table
				|-- 02_Figure
				|-- 03_Illustration
				|-- 04_Report
				|-- 05_Presenatation			
03_FieldWork
  |-- Round
	|-- Survey
		|-- 01_Protocol_and_Manual
		|-- 02_Field_Materials
		|-- 03_Training_Materials
		|-- 04_Field_Team_Hiring

📎 Example Syntax

arcedfold project ABC, path(X:\Projects 2023) author(Mehrab Ali, ARCED Foundation) email([email protected])

arcedfold project ABC, path(X:\Projects 2023) rounds(01_Pilot 02_Baseline) surveys(Camp Host) author(Mehrab Ali, ARCED Foundation) email([email protected])

arcedsubfold project ABC, path(X:\Projects 2023) rounds(02_Baseline) surveys(Schools) author(Mehrab Ali, ARCED Foundation) email([email protected])

arcedsubfold project ABC, path(X:\Projects 2023) rounds(03_Endline) surveys(Camp Host Schools) author(Mehrab Ali, ARCED Foundation) email([email protected])

**# Generate a list of all files and export in an excel file
arcedfold project ABC, path(X:\Projects 2017) final

🧙 Author

Mehrab Ali

ARCED Foundation

Please report all 🐞/feature request to the github issues page

About

arcedfold is a Stata command that creates specific folder structures for projects.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published