Difference between revisions of "Collaboration Tools"
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
Collaboration among a research team is a critical part of nearly all [[Primary Data Collection | data collection]] and impact evaluation activities . With the general availability of low-cost cloud collaboration tools, it is easier and more important than ever to use tools that effectively share access to data and content; protect the privacy, integrity, and history of that content; and impose as low of a learning cost on other collaborators as possible. This page outlines collaboration tools for analysis and paper writing. | |||
==Read First== | |||
*[[Getting started with GitHub | GitHub]] facilitates collaborative coding and preserves every version history of code and outputs | |||
*Cloud Sync tools like [https://www.dropbox.com Dropbox] are useful for sharing code, data, and outputs. While they have limitations (i.e. multiple collaborators often can’t simultaneously work on the same file), they come with a low learning curve and are easy to implement. | |||
*[https://www.overleaf.com/ Overleaf] is a web-based LaTeX collaboration tool that allows multiple authors to simultaneously edit documents. | |||
== | == Analysis == | ||
===GitHub=== | ===GitHub=== | ||
[[GitHub]] allows for multiple data analysts to work on the same project simultaneously | [[Getting started with GitHub | GitHub]] allows for multiple data analysts to work on the same project simultaneously by keeping a local copy of all analysis code and merging final versions together in a centralized repository. GitHub preserves every version history of code and outputs. This makes it easy to recover old code snippets after deleting them from the main production branch and to avail these code snippets to others who may want to review analyses that did not appear in the final publication. | ||
===Cloud Sync Tools=== | ===Cloud Sync Tools=== | ||
Cloud Sync tools, such as Dropbox, are commonly used to share code, data, and outputs with collaborators. Unlike GitHub, sync tools have limited version histories and typically do not allow multiple collaborators to work simultaneously on the same file without version conflicts arising. However, they bear more similarity to traditional filesystem structures, meaning the learning curve is nearly zero for working on files in sync tools. | Cloud Sync tools, such as [https://www.dropbox.com Dropbox], are commonly used to share code, data, and outputs with collaborators. Unlike GitHub, sync tools have limited version histories and typically do not allow multiple collaborators to work simultaneously on the same file without version conflicts arising. However, they bear more similarity to traditional filesystem structures, meaning that the learning curve is nearly zero for working on files in sync tools. | ||
== | == Paper Writing== | ||
===Overleaf=== | ===Overleaf=== | ||
[https://www.overleaf.com/ Overleaf] is a web-based LaTeX collaboration tool that allows multiple authors to simultaneously edit documents. It maintains a folder structure containing a main document, a bibliography document, and images and other resources. It supports limited integrations with Git and Dropbox, and | [https://www.overleaf.com/ Overleaf] is a web-based LaTeX collaboration tool that allows multiple authors to simultaneously edit documents. It maintains a folder structure containing a main document, a bibliography document, and images and other resources. It supports limited integrations with Git and Dropbox, and is currently under active redevelopment following a merger with ShareLaTex, a similar service. | ||
While Overleaf is based on a LaTeX structure, it now offers a "Google-Docs-like" editor and limited comments and version histories, making it easier to collaborate with coauthors who are more comfortable with [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editors like Word. | While Overleaf is based on a LaTeX structure, it now offers a "Google-Docs-like" editor and limited comments and version histories, making it easier to collaborate with coauthors who are more comfortable with [https://en.wikipedia.org/wiki/WYSIWYG WYSIWYG] editors like Word. | ||
== Additional Resources == | == Additional Resources == | ||
* | *DIME Analytics (World Bank), [https://osf.io/hzst9 An Intro to Git and GitHub] | ||
*DIME Analytics (World Bank), [https://osf.io/9652n GitHub Workflow (Pull Request Training)] | |||
*DIME Analytics (World Bank), [https://github.com/worldbank/DIME-Resources/blob/master/git-3-flow.pdf Guide to Using Git and GitHub 3] | |||
*DIME Analytics’ [https://github.com/worldbank/DIME-Resources/blob/master/git-4-management.pdf Maintaining a GitHub Repository] | |||
*DIME Analytics’ [https://github.com/worldbank/DIME-Resources/blob/master/onboarding-3-git.pdf Initializing and Synchronizing a Git Repo with GitHub Desktop] | |||
*DIME Analytics’ [https://github.com/worldbank/DIME-Resources/blob/master/onboarding-4-gitflow.pdf Using Git Flow to Manage Code Projets with GitKraken] | |||
*DIME Analytics (World Bank), [https://github.com/worldbank/dime-github-trainings GitHub Trainings] | |||
*An [http://web.simmons.edu/~wilsonjd/LIS488/website/OverleafTutorial.pdf Introduction to Overleaf] by Alli Gofman and Jaclyn Wilson | |||
[[Category: | [[Category: Technical Tools]] | ||
Latest revision as of 18:29, 30 June 2023
Collaboration among a research team is a critical part of nearly all data collection and impact evaluation activities . With the general availability of low-cost cloud collaboration tools, it is easier and more important than ever to use tools that effectively share access to data and content; protect the privacy, integrity, and history of that content; and impose as low of a learning cost on other collaborators as possible. This page outlines collaboration tools for analysis and paper writing.
Read First
- GitHub facilitates collaborative coding and preserves every version history of code and outputs
- Cloud Sync tools like Dropbox are useful for sharing code, data, and outputs. While they have limitations (i.e. multiple collaborators often can’t simultaneously work on the same file), they come with a low learning curve and are easy to implement.
- Overleaf is a web-based LaTeX collaboration tool that allows multiple authors to simultaneously edit documents.
Analysis
GitHub
GitHub allows for multiple data analysts to work on the same project simultaneously by keeping a local copy of all analysis code and merging final versions together in a centralized repository. GitHub preserves every version history of code and outputs. This makes it easy to recover old code snippets after deleting them from the main production branch and to avail these code snippets to others who may want to review analyses that did not appear in the final publication.
Cloud Sync Tools
Cloud Sync tools, such as Dropbox, are commonly used to share code, data, and outputs with collaborators. Unlike GitHub, sync tools have limited version histories and typically do not allow multiple collaborators to work simultaneously on the same file without version conflicts arising. However, they bear more similarity to traditional filesystem structures, meaning that the learning curve is nearly zero for working on files in sync tools.
Paper Writing
Overleaf
Overleaf is a web-based LaTeX collaboration tool that allows multiple authors to simultaneously edit documents. It maintains a folder structure containing a main document, a bibliography document, and images and other resources. It supports limited integrations with Git and Dropbox, and is currently under active redevelopment following a merger with ShareLaTex, a similar service.
While Overleaf is based on a LaTeX structure, it now offers a "Google-Docs-like" editor and limited comments and version histories, making it easier to collaborate with coauthors who are more comfortable with WYSIWYG editors like Word.
Additional Resources
- DIME Analytics (World Bank), An Intro to Git and GitHub
- DIME Analytics (World Bank), GitHub Workflow (Pull Request Training)
- DIME Analytics (World Bank), Guide to Using Git and GitHub 3
- DIME Analytics’ Maintaining a GitHub Repository
- DIME Analytics’ Initializing and Synchronizing a Git Repo with GitHub Desktop
- DIME Analytics’ Using Git Flow to Manage Code Projets with GitKraken
- DIME Analytics (World Bank), GitHub Trainings
- An Introduction to Overleaf by Alli Gofman and Jaclyn Wilson