Skip to content

Commit

Permalink
Add javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
neesjanvaneck committed Aug 16, 2023
1 parent e0ab323 commit f79b5ed
Show file tree
Hide file tree
Showing 23 changed files with 3,956 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/allclasses-frame.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (publicationclassification e0ab323 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="nl/cwts/publicationclassification/run/DatabaseIO.html" title="class in nl.cwts.publicationclassification.run" target="classFrame">DatabaseIO</a></li>
<li><a href="nl/cwts/publicationclassification/run/FileIO.html" title="class in nl.cwts.publicationclassification.run" target="classFrame">FileIO</a></li>
<li><a href="nl/cwts/publicationclassification/MultiLevelClustering.html" title="class in nl.cwts.publicationclassification" target="classFrame">MultiLevelClustering</a></li>
<li><a href="nl/cwts/publicationclassification/run/PublicationClassificationCreator.html" title="class in nl.cwts.publicationclassification.run" target="classFrame">PublicationClassificationCreator</a></li>
</ul>
</div>
</body>
</html>
21 changes: 21 additions & 0 deletions docs/allclasses-noframe.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (publicationclassification e0ab323 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="nl/cwts/publicationclassification/run/DatabaseIO.html" title="class in nl.cwts.publicationclassification.run">DatabaseIO</a></li>
<li><a href="nl/cwts/publicationclassification/run/FileIO.html" title="class in nl.cwts.publicationclassification.run">FileIO</a></li>
<li><a href="nl/cwts/publicationclassification/MultiLevelClustering.html" title="class in nl.cwts.publicationclassification">MultiLevelClustering</a></li>
<li><a href="nl/cwts/publicationclassification/run/PublicationClassificationCreator.html" title="class in nl.cwts.publicationclassification.run">PublicationClassificationCreator</a></li>
</ul>
</div>
</body>
</html>
176 changes: 176 additions & 0 deletions docs/constant-values.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Constant Field Values (publicationclassification e0ab323 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (publicationclassification e0ab323 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
<h2 title="Contents">Contents</h2>
<ul>
<li><a href="#nl.cwts">nl.cwts.*</a></li>
</ul>
</div>
<div class="constantValuesContainer"><a name="nl.cwts">
<!-- -->
</a>
<h2 title="nl.cwts">nl.cwts.*</h2>
<ul class="blockList">
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>nl.cwts.publicationclassification.run.<a href="nl/cwts/publicationclassification/run/FileIO.html" title="class in nl.cwts.publicationclassification.run">FileIO</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a name="nl.cwts.publicationclassification.run.FileIO.COLUMN_SEPARATOR">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="nl/cwts/publicationclassification/run/FileIO.html#COLUMN_SEPARATOR">COLUMN_SEPARATOR</a></code></td>
<td class="colLast"><code>"\t"</code></td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>nl.cwts.publicationclassification.run.<a href="nl/cwts/publicationclassification/run/PublicationClassificationCreator.html" title="class in nl.cwts.publicationclassification.run">PublicationClassificationCreator</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a name="nl.cwts.publicationclassification.run.PublicationClassificationCreator.DESCRIPTION">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="nl/cwts/publicationclassification/run/PublicationClassificationCreator.html#DESCRIPTION">DESCRIPTION</a></code></td>
<td class="colLast"><code>"PublicationClassificationCreator version 1.0.0\nBy Nees Jan van Eck\nCentre for Science and Technology Studies (CWTS), Leiden University\n"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="nl.cwts.publicationclassification.run.PublicationClassificationCreator.USAGE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
<td><code><a href="nl/cwts/publicationclassification/run/PublicationClassificationCreator.html#USAGE">USAGE</a></code></td>
<td class="colLast"><code>"Usage: PublicationClassificationCreator\n\t&lt;pub_file&gt; &lt;cit_link_file&gt; &lt;classification_file&gt;\n\t&lt;largest_component&gt; &lt;n_iterations&gt;\n\t&lt;resolution_micro_level&gt; &lt;pub_threshold_micro_level&gt;\n\t&lt;resolution_meso_level&gt; &lt;pub_threshold_meso_level&gt;\n\t&lt;resolution_macro_level&gt; &lt;pub_threshold_macro_level&gt;\n\t\t(to create a publication classification based on data in text files)\n\n or PublicationClassificationCreator\n\t&lt;server&gt; &lt;database&gt; &lt;pub_table&gt; &lt;cit_link_table&gt; &lt;classification_table&gt;\n\t&lt;largest_component&gt; &lt;n_iterations&gt;\n\t&lt;resolution_micro_level&gt; &lt;pub_threshold_micro_level&gt;\n\t&lt;resolution_meso_level&gt; &lt;pub_threshold_meso_level&gt;\n\t&lt;resolution_macro_level&gt; &lt;pub_threshold_macro_level&gt;\n\t\t(to create a publication classification based on data in an SQL Server database)\n\nArguments:\n&lt;pub_file&gt;\n\tName of the publications input file. This text file must contain two tab-separated\n\tcolumns (without a header line), first a column of publication numbers and then a\n\tcolumn of core publication indicators (1 for core publications and 0 for non-core\n\tpublications). Publication numbers must be integers starting at zero. Non-core\n\tpublications are auxiliary publications that can be included to improve the clustering\n\tof core publications. The lines in the file must be sorted by the publication numbers\n\tin the first column.\n&lt;cit_link_file&gt;\n\tName of the citation links input file. This text file must contain three tab-separated\n\tcolumns (without a header line), first two columns of publication numbers and then a\n\tcolumn of weights. Each citation link must be included only once in the file. The\n\tlines in the file must be sorted first by the publication numbers in the first column\n\tand then by the publication numbers in the second column.\n&lt;classification_file&gt;\n\tName of the classification output file. This text file will contain four tab-separated\n\tcolumns (without a header line), first a column of publication numbers and then three\n\tcolumns of cluster numbers at the micro, meso, and macro level. Cluster numbers are\n\tintegers starting at zero.\n&lt;server&gt;\n\tSQL Server server name. A connection will be made using integrated authentication.\n&lt;database&gt;\n\tDatabase name.\n&lt;pub_table&gt;\n\tName of the publications input table. This table must have two columns: pub_no and\n\tcore_pub. Publication numbers must be integers starting at zero. Non-core\n\tpublications (core_pub = 0) are auxiliary publications that can be included to improve\n\tthe clustering of core publications (core_pub = 1).\n&lt;cit_link_table&gt;\n\tName of the citation links input table. This table must have three columns: pub_no1,\n\tpub_no2, and cit_weight. Each citation link must be included only once in the table.\n&lt;classification_table&gt;\n\tName of the classification output table. This table will have four columns: pub_no,\n\tmicro_cluster_no, meso_cluster_no, and macro_cluster_no. Cluster numbers are integers\n\tstarting at zero.\n&lt;largest_component&gt;\n\tBoolean indicating whether the publication classification should include only\n\tpublications belonging to the largest connected component of the citation network\n\t(\'true\') or all publications (\'false\').\n&lt;n_iterations&gt;\n\tNumber of iterations of the Leiden algorithm (e.g., 50).\n&lt;resolution_micro_level&gt;\n\tValue of the resolution parameter at the micro level.\n&lt;pub_threshold_micro_level&gt;\n\tMinimum number of publications per cluster at the micro level (excluding non-core\n\tpublications).\n&lt;resolution_meso_level&gt;\n\tValue of the resolution parameter at the meso level.\n&lt;pub_threshold_meso_level&gt;\n\tMinimum number of publications per cluster at the meso level (excluding non-core\n\tpublications).\n&lt;resolution_macro_level&gt;\n\tValue of the resolution parameter at the macro level.\n&lt;pub_threshold_macro_level&gt;\n\tMinimum number of publications per cluster at the macro level (excluding non-core\n\tpublications).\n"</code></td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
121 changes: 121 additions & 0 deletions docs/deprecated-list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Deprecated List (publicationclassification e0ab323 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Deprecated List (publicationclassification e0ab323 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="navBarCell1Rev">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Deprecated API" class="title">Deprecated API</h1>
<h2 title="Contents">Contents</h2>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="navBarCell1Rev">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Loading

0 comments on commit f79b5ed

Please sign in to comment.