Updated documentation to include subsection searches

Darkbladecr · Aug 25, 2016 · 2e3d4be · 2e3d4be
1 parent 034fd5a
commit 2e3d4be
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -92,4 +92,4 @@ ENV/
 *.paw
 *.npy
 *.xlsx
-subsections/**.*
+
diff --git a/readme.md b/readme.md
@@ -9,9 +9,10 @@ A Python script with Scopus and PubMed APIs built in to give you an overview of
 - Citation Index (citations per year)
 - Author [*h*-index](https://en.wikipedia.org/wiki/H-index)
 - Journal publications
+- Article country of origin
 
-![Example Data](https://github.com/Darkbladecr/pyresearch/blob/master/example%20output/example_data.png?raw=true)
-![Example Author Data](https://github.com/Darkbladecr/pyresearch/blob/master/example%20output/example_authors.png?raw=true)
+![Example Data](https://github.com/Darkbladecr/pyresearch/blob/master/screenshots/example_data.png?raw=true)
+![Example Author Data](https://github.com/Darkbladecr/pyresearch/blob/master/screenshots/example_authors.png?raw=true)
 
 ## Download & Setup
 1. Download this repository's [Latest Release](https://github.com/Darkbladecr/pyresearch/archive/master.zip) and navigate Terminal to the downloaded file:
@@ -42,7 +43,7 @@ For example a search for the articles on Focused Ultrasound in the Brain could b
 
 `-s or --search` is used for your search query.
 
-![Example Terminal](https://github.com/Darkbladecr/pyresearch/blob/master/example%20output/terminal.png?raw=true)
+![Example Terminal](https://github.com/Darkbladecr/pyresearch/blob/master/screenshots/terminal.png?raw=true)
 
 The script will go through its various steps and let you know the progress. When it is complete it will save an excel document into the same directory as the script.
 
@@ -61,6 +62,8 @@ For example, if I wanted to find all the articles based on Focused Ultrasound in
 
 `-i or --input` is used for the filename of your `*.xlsx` file and your `*.npy` note they must share the same name. The inital pyresearch script outputs these files, however note if you rename only one then the subsection script will not work.
 
+![Example Subsection Terminal](https://github.com/Darkbladecr/pyresearch/blob/master/screenshots/example_subsection.png?raw=true)
+
 ## Troubleshooting
 If you get an error such as:
 ```

diff --git a/example output/example_authors.png → screenshots/example_authors.png b/example output/example_authors.png → screenshots/example_authors.png
diff --git a/example output/example_data.png → screenshots/example_data.png b/example output/example_data.png → screenshots/example_data.png
diff --git a/example output/example_subsection.png → screenshots/example_subsection.png b/example output/example_subsection.png → screenshots/example_subsection.png
diff --git a/example output/terminal.png → screenshots/terminal.png b/example output/terminal.png → screenshots/terminal.png
diff --git a/subsections/example.txt b/subsections/example.txt
@@ -0,0 +1,2 @@
+python pyresearch.py -s "Focused Ultrasound AND Brain"
+python pyresearch_subsection.py -s "Focused Ultrasound AND Brain AND Essential Tremor" -t "Essential Tremor" -i "data-2016-08-23"
-Original file line number
+Diff line change
@@ Expand Up / @@ -92,4 +92,4 @@ ENV/ @@
     *.paw
     *.npy
     *.xlsx
-    subsections/**.*
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		python pyresearch.py -s "Focused Ultrasound AND Brain"
		python pyresearch_subsection.py -s "Focused Ultrasound AND Brain AND Essential Tremor" -t "Essential Tremor" -i "data-2016-08-23"