MediaWiki Redirect Tools
=======================================================================
- | **Author:** `Benjamin Mako Hill`__ <mako@atdot.cc>
- | **Homepage:** http://networkcollectiv.es/wiki-redirects/
- | **License:** `GNU GPLv3 or any later version`__ (see COPYING)
+ | **Author:** `Benjamin Mako Hill`__ <mako@atdot.cc> and `Aaron Shaw`__ <aaron.d.shaw@gmail.com>
+ | **Homepage:** http://communitydata.cc/wiki-redirects/
+ | **Code:** http://projects.mako.cc/source/?p=redirect-tools
+ | **License:** `GNU GPLv3 or any later version`__
| **Description:** Tools to to generate a redirect spells dataset from "raw" MediaWiki XML dumps like those published by the Wikimedia foundation.
__ http://mako.cc/
+__ http://aaronshaw.org/
__ http://www.gnu.org/copyleft/gpl.html
-If you use this software for research, please **cite the following
-paper** in any resulting publication:
+If you use this software for research, please cite the following
+paper:
- *Hill, Benjamin Mako and Aaron Shaw. "Consider the Redirect: A Missing
- Dimension of Wikipedia Research." In Proceedings of the 10th International
- Symposium on Open Collaboration (OpenSym 2014). ACM Press, 2014.*
+ *Hill, Benjamin Mako and Aaron Shaw. "Consider the Redirect: A
+ Missing Dimension of Wikipedia Research." In Proceedings of the 10th
+ International Symposium on Open Collaboration (OpenSym 2014). ACM
+ Press, 2014.*
**Overview:**
Before you start, you may also want to change the default directories for writing intermediate output files. The default directories for writing and reading files are at the top of the file `redirect_tools.R` and can be changed by editing that file. By default, all files will be written to the subdirectory "./output" in the local directory. If you want to use the default directories, you will still need to create them with a command like this::
- mkdir output; output/redir; output/spells
+ mkdir output output/redir output/spells
-Step 2: Find Redirects in Revisions
-=======================================================================
+Step 1: Find Redirects in Revisions
+-----------------------------------------
Dependencies:
- bzip2 compressed TSV files (one line per revision)
-You will run the `01-extract_redirects.py` script to build a dataset of revisions or edits that marks every revisions as either containinig a revision, or not.
-
-Then, the script `01-extract_redirects.py` will take a MediaWiki dump file on STDIN and output a TSV file on STDOUT of the following form.
+You will run the `01-extract_redirects.py` script to build a dataset of revisions or edits that marks every revisions as either containing a redirect, or not. `01-extract_redirects.py` takes a MediaWiki dump file on STDIN and output a TSV file on STDOUT of the following form:
+---------+-------------+--------------------------------+------------+---------+----------+--------------------+
| page.id | revision.id | page.title | timestamp | deleted | redirect | target |
In this (example) case, the first revision of the article "Mikhail Alekseevich Lavrentiev" was not a redirect but the second is a redirect to "Mikhail Lavrentyev."
-If you are using the Simple English dump (which is a single file) you would run the following command to send the output to the default destination::
+If you are using the Simple English dump (which is a single file) you would run the following command to uncompress the dump, parse it using our script, compress the output again, and save the output to the default destination::
7za x -so simplewiki-20140410-pages-meta-history.xml.7z |
python2.7 01-extract_redirects.py | bzip2 -c - > output/redir/simple_redirs.tsz.bz2
Step 2: Generate spells
-=======================================================================
+-----------------------------------------
Dependencies:
- GNU R
- data.table (http://cran.r-project.org/web/packages/data.table/)
-- foriegn (http://cran.r-project.org/web/packages/foreign/)
+- foreign (http://cran.r-project.org/web/packages/foreign/)
Input:
R --no-save < 02-generate_spells.R
-By default, output will be saved into `output/spells`.
+By default, output will be saved into `output/spells`. The script will
+save three versions of the output:
-The
+1. `redirect_spells.RData` — An RData file suitable for use in GNU R
+2. `redirect_spells.tsv` — A tab seperated values file suitable for use in a variety of different programs.
+3. `redirect_spells.dta` — A DTA file suitable for use in Stata (many versions will crop very long artiicle titles due to limitations in the DTA format).
-Running Code in Parallel
-=======================================================================
-Because the full history dumps from the WMF foundation are split into many
-files, it is can be appropriate to parse these dumps in parallel. Although the
-specific ways you choose to do this will vary by the queuing system you use,
-we've included examples of the scripts we used with Condor on the Harvard/MIT
-Data Center (HMDC) in the "examples/" directory. They will not work without
-modification for your computing environment because they have our environment
-hardcoded in but they will give you an idea of where you might want to start.
-
-Additionally, there is a third step `03-assemble_redirect_spells.R` that
-contains R code that will read in all of the separate RData files, assmebles
-the many smaller dataframes into a single data.frame, and then saves that
-unified data.frame into a single RData file.
+Running Code in Parallel
+-----------------------------------------
+
+Because the full history dumps from the WMF foundation are split into
+many files, it is usually appropriate to parse these dumps in
+parallel. Although the specific ways you choose to do this will vary
+by the queuing or scheduling system you use, we've included examples
+of the scripts we used with Condor on the Harvard/MIT Data Center
+(HMDC) in the `examples/` directory of the source code. They will not
+work without modification for your computing environment because they
+have configuration options and paths for our environment
+hardcoded. That said, they may give you an idea of where you might
+want to start.
+
+In this parallel code there is a third file
+`03-assemble_redirect_spells.R` that contains R code that will read in
+all of the separate RData files created in paralell processing,
+assemble the many smaller dataframes into a single dataframe, and then
+saves that unified data.frame into a single RData file.
projects / redirect-tools / blobdiff