Skip to content

Commit

Permalink
Update usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew-S-Rosen authored Oct 12, 2024
1 parent 3010c85 commit fd11f36
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

Fetch your Google Scholar ID, which is the string of letters and numbers in the URL of your Google Scholar profile page between `user=` and `&hl=`.

## Example
## Examples

If generating an NSF COA report, all you need to do is the following:

```python
from coapy.scholar import get_coauthors
Expand All @@ -13,3 +15,16 @@ scholar_id = "lHBjgLsAAAAJ" # Google Scholar ID
my_coauthors = get_coauthors(scholar_id=scholar_id)
print(my_coauthors)
```

If for any reason you need to get >2 years of data, this can be modified as follows:


## Example

```python
from coapy.scholar import get_coauthors

scholar_id = "lHBjgLsAAAAJ" # Google Scholar ID
my_coauthors = get_coauthors(scholar_id=scholar_id, years_back=4)
print(my_coauthors)
```

0 comments on commit fd11f36

Please sign in to comment.