Editing CommunityData:Introduction to CDSC Resources

From CommunityData

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
If you're new to the group, welcome!  
If you're new to the group, welcome!  


This is an introduction to some of the tools we use (and we use many!) in our research work. It may be helpful to look at before diving into everything and starting your research with/in this group. You can find additional information on the resources mentioned below on the [https://wiki.communitydata.science/CommunityData:Resources Resources] page. The Resources page will generally list more resources and details than those listed here.
This is an introduction to the various technical tools we use (as we use many) in our research work. It may be helpful to look at before diving into everything and starting your research with/in this group. You can find any of the resources mentioned below on the [https://wiki.communitydata.science/CommunityData:Resources Resources] page, (mostly) organized by alphabetical order for quick finding.


To start, here's some [https://wiki.communitydata.science/CommunityData:Jargon common shorthand] that members might use. It's a little outdated but has some acronyms, names of things, etc. that might pop up in conversation.
To start, here's some [https://wiki.communitydata.science/CommunityData:Jargon common shorthand] that members might use.
 
There's [https://communitydata.science/~mako/cdsc_only/jitsi-onboarding_session-20200629.mp4 a video introduction from June 29 2020 online here]. It's hosted in [[Mako's]] <code>cdsc_only</code> video repository so there's a username and and password but you can ask anybody in the group and they should be able to get it by searching their email for "cdsc_only".


== Communication Channels ==
== Communication Channels ==
We communicate on multiple channels!
* One might contact specific [https://wiki.communitydata.science/People members] directly.
* We use email lists to communicate things relevant to the ''entire'' group or subgroup, like upcoming events or circulating papers for feedback: [https://wiki.communitydata.science/CommunityData:Email CDSC - Email]
* We communicate (chat) much more frequently on [https://wiki.communitydata.science/CommunityData:Resources#Chat_on_IRC IRC]
* For weekly meetings and other (video)calls, we videocall using Jitsi. There are a lot of us, which can make calls a little hectic, so please keep in mind some [https://wiki.communitydata.science/CommunityData:Jitsi Jitsi etiquette].
* We also have a calendar of group-wide events: [https://wiki.communitydata.science/Schedule CDSC Calendar].


* We communicate (chat) frequently on [[CommunityData:IRC|IRC]]
== Shared Resources ==
* We use email lists to communicate things relevant to the ''entire'' group or subgroup, like upcoming events or circulating papers for feedback: [[CommunityData:Email|CDSC - Email]]
* We maintain a large shared [https://wiki.communitydata.science/CommunityData:Zotero Zotero] directory that is really helpful for finding relevant papers and smooths the process of collaboration (as one can see the papers and sources stored by collaborators as well).
* One can also contact specific [[People|members]] directly.
* We also have a Git repository with some shared resources (both technical and non-technical) on it:
* For weekly meetings and other (video)calls, we typically use Jitsi. There are a lot of us, which can make calls a little hectic, so please keep in mind some [[CommunityData:Jitsi|Jitsi etiquette]].
** [[CommunityData:Git]] — Getting set up on the git server
* We also have a calendar of group-wide events: [[Schedule|CDSC Calendar]], such as the retreats.
** [[CommunityData:Code]] — List of software projects maintained by the collective.


We also have some public facing channels:
== Servers and Data Stuff ==
Hyak is a supercomputer system that may or may not be relevant to your research project. For example, if you're running code on a huge dataset, you might want to use Hyak. You can learn more about it [https://wiki.communitydata.science/CommunityData:Hyak here]. If you want to get an account and get set up on Hyak, look at the Hyak Set-Up page:
* [[CommunityData:Hyak setup]]


* We have a variety of [[CommunityData:Blog and social media| various social media accounts]] including [https://blog.communitydata.science the Community Data Science blog], Twitter, Youtube, Mastodon, and so on. That page has details about to get accounts.
When using Hyak (or other servers), these pages might be helpful:
* [[CommunityData:Tmux]] — You can use tmux (terminal multiplexer) to keep a persistent session on a server. Check out the [https://github.com/tmux/tmux/wiki tmux git repo] or its [https://en.wikipedia.org/wiki/Tmux Wikipedia page] for more information about this.
* [[CommunityData:Hyak Spark]] — Spark is a powerful tool that helps build programs dealing with large datasets.


== Collaboration tools ==
Nada is used for backups.
* ''[[CommunityData:Wiki|This wiki]]'': The CDSC Wiki includes group resources, as well as things like research project pages and course websites. It is highly recommended that you create an account and then reach out to someone else in the group to make you an admin. This will help you to avoid having your edits reverted.
* [[CommunityData:Backups (nada)]] — Details on what is, and what isn't, backed up from nada.
* ''Bibliographic references'': We maintain a large shared [[CommunityData:Zotero|Zotero]] directory that is really helpful for finding relevant papers and smooths the process of collaboration (as one can see the papers and sources stored by collaborators as well). Please review the Zotero etiquette described on the "[[CommunityData:Zotero#Adding_and_Organizing_References|Adding and Organizing References]]" and "[[CommunityData:Zotero#Tips_and_Tricks|Tips and Tricks]]" sections of [[CommunityData:Zotero|Zotero]] before using the shared folder.
* ''LaTeX authoring'': Some of us work on papers and presentations together in [https://overleaf.com Overleaf]. See additional info about this [[CommunityData:Introduction_to_CDSC_Resources#Creating_Documents_and_Presentations|below]]. You can get a free account to join a project or two and use the basic functionalities of Overleaf. More sustained use of more features probably means you should join the cdsc account or another paid account. We don't have a CDSC overleaf info page (yet). if you think you need to join the CDSC group account, contact Aaron about that.
* ''Meeting Poll Tools'': We use [http://whenisgood.net When Is Good] for a lot of our meeting polls. Here are some [[CommunityData:HowToWhenToMeet|tips, tricks and norms about filling out meeting polls]]
* ''Version control'': We also have a Git repository with some shared resources (both technical and non-technical) on it:
** ''Git repositories'': [[CommunityData:Git]] — How to get set up on the git server to create, clone, work on/in shared git repositories we maintain.
** ''Software projects'': [[CommunityData:Code]] — List of software projects maintained by the collective.


== Computation: Servers, data, and more ==
=== Re: Wiki Data ===
Much of our work is pretty computational/quantitative and involves large datasets. We have multiple computing resources and servers.
* [[CommunityData:ORES]] - Using ORES with wikipedia data
 
* [[CommunityData:Wikia data]] — Documents information about how to get and validate wikia dumps.
;Hyak: Hyak is a supercomputer system that is hosted at UW but that the whole group uses for conducting statistical analysis and data processing. Hyak is necessary if you need large amounts of storage (e.g., tens of terabytes) or if you need large amount of computational resources (e.g., CPU time, memory, etc). ''Servers in Hyak do not have direct access to the Internet.'' (except for 'build' machines). That means that Hyak is not useful for collecting data from APIs, etc. Access requires a UW NetID but they will be sponsored for you. You can learn more about it at: [[CommunityData:Hyak]] which has various links to tutorials/documentation as well.
 
:In order to use Hyak, you need to get an account setup. This is documented on [[CommunityData:Hyak setup]].
 
;Kibo: Kibo is a server we use for research hosted at Northwestern that came online in 2018-2019. Kibo is only a single machine but it is very powerful and is connected to the Internet. It has several dozen terabytes of space, a large amount of memory, and many CPUs. We use it primarily for (a) data collection APIs and (b) publication of large datasets like the data from the CDSC [[COVID-19 Digital Observatory]]. Access requires a NU NetID but they will be sponsored for you. More details are on [[CommunityData:Kibo]].
 
;Nada: Nada is a sever at UW that is used primarily for infrastructure. It runs the blogs, mailing lists, git repositories and so on. We backup all of nada and these backups can be very expensive. Before you download or use data on Nada, please read the page [[CommunityData:Backups (nada)]] which provide details on what is, and what isn't, backed up from nada.
 
;Asha: Asha is a server at UW that is used for storing and analyzing Scratch data. Only people on the IRB protocol for Scratch are online.
 
When using servers, these pages might be helpful:
* [[CommunityData:Tmux]] — You can use tmux (terminal multiplexer) to keep a persistent session on a server, even if you're not logged into the server. This is especially helpful when you ssh to a server and then run a job that runs for quite a while and then you can't stay logged in the whole time. Check out the [https://github.com/tmux/tmux/wiki tmux git repo] or its [https://en.wikipedia.org/wiki/Tmux Wikipedia page] for more information about this.
* [[CommunityData:Hyak Spark]] — Spark is a powerful tool that helps build programs dealing with large datasets. It's great for Wikimedia and Reddit data dumps.
 
=== Wiki Data in particular===
Multiple people in the group work on large datasets gathered from Wikipedia, Wikia (Fandom), or other projects running MediaWiki software. We have some specific resources and tools for these kinds of data
* [[CommunityData:ORES]] - Using ORES with Wikipedia data
* [[CommunityData:Wikia data]] — How to get and validate wikia dumps.
* [[CommunityData:Wikiq]] - Processing MediaWiki XML dumps, outputting parsed dumps as tsv (which can then be processed by the very powerful Spark).


== Creating Documents and Presentations ==
== Creating Documents and Presentations ==
=== Planning ===
=== Planning ===
You can develop a research plan in whatever way works best, but one thing that may be useful is the outline of a [[CommunityData:Planning document |Matsuzaki-style planning documents]] and the [[CommunityData:Qualitative planning document|qualitative planning document]]. You can see a detailed outline description [https://wiki.communitydata.science/CommunityData:Planning_document here] to help guide the planning process. If you scroll to the bottom, you'll see who to contact to get some good examples of planning documents.
You can develop a research plan in whatever way works best, but one thing that may be useful is the outline of a Matsuzaki-style planning documents. You can see a detailed outline description [https://wiki.communitydata.science/CommunityData:Planning_document here] to help guide the planning process. If you scroll to the bottom, you'll see who to contact to get some good examples of planning documents.
 
Also helpful in developing a research plan might be some of the readings in this course taught by Aaron to PhD students: [https://wiki.communitydata.science/Practice_of_scholarship_(Spring_2019) Practice of Scholarship (SP19)].


=== Paper building ===
=== Paper building ===
We typically write LaTeX documents when writing papers. One option to do this is to use the web-based [https://www.overleaf.com/ Overleaf]. Another option, using CDSC TeX templates, is detailed [https://wiki.communitydata.science/CommunityData:TeX here]. These comes with some assumptions about your workflow, which you can learn about here: [[CommunityData:Build papers]].
We typically write LaTeX documents. One option to do this is to use the web-based [https://www.overleaf.com/ Overleaf]. Another option, using CDSC TeX templates, is detailed [https://wiki.communitydata.science/CommunityData:TeX here]. These comes with some assumptions about your workflow, which you can learn about here: [[CommunityData:Build papers]].


If you're creating graphs and tables or formatting numbers in R that you want to put into a TeX document, you should look at the [https://wiki.communitydata.science/CommunityData:Knitr knitr package].
If you're creating graphs and tables or formatting numbers in R that you want to put into a TeX document, you should look at the [https://wiki.communitydata.science/CommunityData:Knitr knitr package].


Some more specific things that might crop up in building the La/TeX document:
Some more specific things that might crop up:
* [[CommunityData:Embedding fonts in PDFs]] — <code>ggplot2</code> creates PDFs with fonts that are not embedded which, in turn, causes the ACM to bounce our papers back. This page describes how to fix it.
* [[CommunityData:Embedding fonts in PDFs]] — <code>ggplot2</code> creates PDFs with fonts that are not embedded which, in turn, causes the ACM to bounce our papers back. This page describes how to fix it.


=== Building presentation slides ===
=== Building presentation slides ===
Below are some options to creating presentation slides (though, feel free to use what you want and are most comfortable with):
Below are some options to creating presentation slides (though, feel free to use what you want nd are most comfortable with):
* [[CommunityData:Beamer]] — Beamer is a LaTeX document class for creating presentation slides. This is a link to installing/using [[Mako]]'s beamer templates.
* [[CommunityData:Beamer]] — Beamer is a LaTeX document class for creating presentation slides. This is a link to installing/using [[Mako]]'s beamer templates.
** Again, like the CDSC TeX templates, these Beamer templates also come with some assumptions about your workflow, which you can learn about here (again): [[CommunityData:Build papers]].
** Again, like the CDSC TeX templates, these Beamer templates also come with some assumptions about your workflow, which you can learn about here (again): [[CommunityData:Build papers]].
Line 73: Line 52:
* [[CommunityData:reveal.js]] — Using RMarkdown to create reveal.js HTML presentations
* [[CommunityData:reveal.js]] — Using RMarkdown to create reveal.js HTML presentations


== A few additional resources ==
== Misc. Resources ==
=== Technical ===
=== Technical ===
* [[CommunityData:Exporting from Python to R]]
* [[CommunityData:Exporting from Python to R]]
Line 80: Line 59:
=== Non-technical ===
=== Non-technical ===
* [[CommunityData:Advice on writing a background section to an academic paper]]
* [[CommunityData:Advice on writing a background section to an academic paper]]
* See some past and upcoming lab retreats [[CommunityData:Resources#Ongoing_and_Future_Meetings_and_Meetups|here]].
* See some past and upcoming lab retreats [[https://wiki.communitydata.science/CommunityData:Resources#Ongoing_and_Future_Meetings_and_Meetups here]].
Please note that all contributions to CommunityData are considered to be released under the Attribution-Share Alike 3.0 Unported (see CommunityData:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following CAPTCHA:

Cancel Editing help (opens in new window)
Retrieved from "https://wiki.communitydata.science/CommunityData:Introduction_to_CDSC_Resources"
Attribution-Share Alike 3.0 Unported
Powered by MediaWiki