Skip to content

Commit a9b735b

Browse files
committed
updating generated files- from nav bar and minor changes
1 parent 390e0cd commit a9b735b

File tree

237 files changed

+23293
-3498
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

237 files changed

+23293
-3498
lines changed

README.md

+52-43
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,109 @@
1-
---
2-
title: "patentsview"
3-
output: github_document
4-
---
1+
patentsview
2+
================
53

4+
# patentsview <img src="man/figures/logo.png" align="right" height="200" style="float:right; height:200px;" alt="Package Logo"/>
65

7-
8-
# patentsview <img src="man/figures/logo.png" align="right" height="200" style="float:right; height:200px;" />
96
> An R client to the PatentsView API
107
118
[![](http://badges.ropensci.org/112_status.svg)](https://github.com/ropensci/software-review/issues/112)
129
[![R-CMD-check](https://github.com/ropensci/patentsview/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/patentsview/actions)
13-
[![CRAN version](http://www.r-pkg.org/badges/version/patentsview)](https://cran.r-project.org/package=patentsview)
10+
[![CRAN
11+
version](http://www.r-pkg.org/badges/version/patentsview)](https://cran.r-project.org/package=patentsview)
1412
[![](https://mustberuss.r-universe.dev/badges/patentsview)](https://mustberuss.r-universe.dev/ui#package:patentsview)
1513

16-
This is the R package for the new beta version of the patentsview API
17-
To get a sense of what's going on with the API, check out the following
18-
19-
* the skips() in the unit tests test/testthat/*.R
20-
* the try/catch block in test/testthat/test-fetch-each-field.R
21-
* comments in data-raw/openAPI_to_csv.pl
22-
23-
2414
## Installation
2515

26-
You can get the stable version for the original version of the API from CRAN:
27-
16+
You can get the stable version for the original version of the API from
17+
CRAN:
2818

29-
```r
19+
``` r
3020
install.packages("patentsview")
3121
```
3222

3323
Or the development version from GitHub:
3424

35-
36-
```r
25+
``` r
3726
if (!"devtools" %in% rownames(installed.packages())) {
3827
install.packages("devtools")
3928
}
4029

4130
devtools::install_github("ropensci/patentsview")
4231
```
32+
4333
Or the R package for the new version of the API from github:
44-
```
45-
if (!"devtools" %in% rownames(installed.packages())) {
46-
devtools::install_github("ropensci/patentsview@api-redesign")
47-
}
48-
```
49-
Or the R package for the new version of the API from r-universe:
5034

35+
if (!"devtools" %in% rownames(installed.packages())) {
36+
devtools::install_github("ropensci/patentsview@api-redesign")
37+
}
5138

52-
```r
39+
Or the R package for the new version of the API from r-universe:
40+
41+
``` r
5342
options(repos = c(
5443
patentsview = "https://mustberuss.r-universe.dev/",
5544
CRAN = "https://cloud.r-project.org"
5645
))
5746

5847
install.packages("patentsview")
5948
```
49+
6050
## Important API Change
6151

62-
The new version of the API requires an api key, or all of your requests will be blocked. An API key can be optained [here](https://patentsview-support.atlassian.net/servicedesk/customer/portal/1/group/1/create/18). The updated R package will look for an environmental variable PATENTSVIEW_API_KEY set to the value of your key. For windows it would be
63-
```
64-
set PATENTSVIEW_API_KEY=my_keys_value_without quotes
65-
```
52+
The new version of the API requires an api key, or all of your requests
53+
will be blocked. An API key can be optained
54+
[here](https://patentsview.org/apis/keyrequest). The updated R package
55+
will look for an environmental variable PATENTSVIEW_API_KEY set to the
56+
value of your key. For windows it would be
6657

67-
See [this page](https://mustberuss.github.io/patentsview/articles/api-changes.html) about the change. The navigation there will get you to the updated vignettes and reference pages.
58+
set PATENTSVIEW_API_KEY=my_keys_value_without quotes
6859

69-
## Basic usage
60+
See [this
61+
page](https://mustberuss.github.io/patentsview/articles/api-changes.html)
62+
about the change. The navigation there will get you to the updated
63+
vignettes and reference pages.
7064

71-
The [PatentsView API](https://patentsview.org/apis/api-endpoints) provides an interface to a disambiguated version of USPTO. The `patentsview` R package provides one main function, `search_pv()`, to make it easy to interact with the API:
65+
## Basic usage
7266

67+
The [PatentsView API](https://patentsview.org/apis/api-endpoints)
68+
provides an interface to a disambiguated version of USPTO. The
69+
`patentsview` R package provides one main function, `search_pv()`, to
70+
make it easy to interact with the API:
7371

74-
```r
72+
``` r
7573
library(patentsview)
7674

7775
search_pv(query = '{"_gte":{"patent_date":"2007-01-01"}}')
7876
#> $data
7977
#> #### A list with a single data frame on patents level:
8078
#>
8179
#> List of 1
82-
#> $ patents:'data.frame': 1000 obs. of 3 variables:
80+
#> $ patents:'data.frame': 1000 obs. of 3 variables:
8381
#> ..$ patent_id : chr [1:1000] "10000000" ...
8482
#> ..$ patent_title: chr [1:1000] "Coherent LADAR using intra-pixel quadrature"..
8583
#> ..$ patent_date : chr [1:1000] "2018-06-19" ...
8684
#>
8785
#> $query_results
8886
#> #### Distinct entity counts across all downloadable pages of output:
8987
#>
90-
#> total_hits = 4,642,018
88+
#> total_hits = 5,362,291
9189
```
9290

9391
## Learning more
9492

95-
Head over to the package's [webpage](https://docs.ropensci.org/patentsview/index.html) for more info, including:
96-
97-
* A [getting started vignette](https://docs.ropensci.org/patentsview/articles/getting-started.html) for first-time users. The package was also introduced in an [rOpenSci blog post](https://ropensci.org/blog/2017/09/19/patentsview/).
98-
* An in-depth tutorial on [writing queries](https://docs.ropensci.org/patentsview/articles/writing-queries.html)
99-
* A list of [basic examples](https://docs.ropensci.org/patentsview/articles/examples.html)
100-
* Two examples of data applications (e.g., a brief analysis of the [top assignees](https://docs.ropensci.org/patentsview/articles/top-assignees.html) in the field of databases)
93+
Head over to the package’s
94+
[webpage](https://docs.ropensci.org/patentsview/index.html) for more
95+
info, including:
96+
97+
- A [getting started
98+
vignette](https://docs.ropensci.org/patentsview/articles/getting-started.html)
99+
for first-time users. The package was also introduced in an
100+
[rOpenSci blog
101+
post](https://ropensci.org/blog/2017/09/19/patentsview/).
102+
- An in-depth tutorial on [writing
103+
queries](https://docs.ropensci.org/patentsview/articles/writing-queries.html)
104+
- A list of [basic
105+
examples](https://docs.ropensci.org/patentsview/articles/examples.html)
106+
- Two examples of data applications (e.g., a brief analysis of the
107+
[top
108+
assignees](https://docs.ropensci.org/patentsview/articles/top-assignees.html)
109+
in the field of databases)

docs/404.html

+62-146
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)