add defunct section to pkg level man file; update readme

R/rdatacite-package.R

@@ -1,17 +1,37 @@
-#' DataCite R client.
+#' DataCite R client
 #'
-#' @section REST API functions:
+#' @section Methods in the package:
 #'
-#' - [dc_activities()] - xxx
-#' - [dc_client_prefixes()] - xxx
-#' - [dc_clients()] - xxx
-#' - [dc_dois()] - xxx
-#' - [dc_events()] - xxx
-#' - [dc_prefixes()] - xxx
-#' - [dc_provider_prefixes()] - xxx
-#' - [dc_providers()] - xxx
-#' - [dc_reports()] - xxx
-#' - [dc_status()] - xxx
+#' - [dc_providers()]
+#' - [dc_reports()]
+#' - [dc_check()]
+#' - [dc_events()]
+#' - [dc_dois()]
+#' - [dc_clients()]
+#' - [dc_client_prefixes()]
+#' - [dc_provider_prefixes()]
+#' - [dc_status()]
+#' - [dc_prefixes()]
+#' - [dc_activities()]
+#' 
+#' @section rdatacite defunct functions:
+#' 
+#' - `dc_data_center`
+#' - `dc_data_centers`
+#' - `dc_facet`
+#' - `dc_member`
+#' - `dc_members`
+#' - `dc_mlt`
+#' - `dc_oai_getrecord`
+#' - `dc_oai_identify`
+#' - `dc_oai_listidentifiers`
+#' - `dc_oai_listmetadataformats`
+#' - `dc_oai_listrecords`
+#' - `dc_oai_listsets`
+#' - `dc_search`
+#' - `dc_stats`
+#' - `dc_work`
+#' - `dc_works`
 #'
 #' @name rdatacite-package
 #' @aliases rdatacite

README.md

@@ -21,6 +21,7 @@ Package API:
 
  - `dc_providers`
  - `dc_reports`
+ - `dc_check`
  - `dc_events`
  - `dc_dois`
  - `dc_clients`
@@ -67,51 +68,46 @@ You may want to start with `dc_dois()`.
 ```r
 dc_dois(query = "climate change")
 #> datacite: dois
-#> found: 340593, pages: 400, page: 1
+#> found: 340596, pages: 400, page: 1
 #> slots: data, included, meta, links
 #> $data
 #> # A tibble: 25 x 4
 #>    id    type  attributes$doi $identifiers $creators $titles $publisher
 #>    <chr> <chr> <chr>          <list>       <list>    <list>  <chr>     
-#>  1 10.5… dois  10.5281/zenod… <df[,2] [2 … <df[,6] … <df[,1… Zenodo    
-#>  2 10.5… dois  10.5281/zenod… <df[,2] [2 … <df[,6] … <df[,1… Zenodo    
-#>  3 10.1… dois  10.13140/rg.2… <df[,2] [1 … <df[,6] … <df[,1… Unpublish…
-#>  4 10.5… dois  10.5061/dryad… <df[,2] [1 … <df[,6] … <df[,1… Dryad     
-#>  5 10.1… dois  10.13140/rg.2… <df[,2] [1 … <df[,6] … <df[,1… Unpublish…
-#>  6 10.5… dois  10.5278/ojs.c… <df[,2] [2 … <df[,6] … <df[,1… Coaching …
-#>  7 10.6… dois  10.6084/m9.fi… <df[,2] [1 … <df[,6] … <df[,1… Taylor & …
-#>  8 10.6… dois  10.6084/m9.fi… <df[,2] [1 … <df[,6] … <df[,1… Taylor & …
-#>  9 10.6… dois  10.6084/m9.fi… <df[,2] [1 … <df[,6] … <df[,1… Taylor & …
-#> 10 10.2… dois  10.24435/mate… <df[,2] [1 … <df[,6] … <df[,1… Materials…
+#>  1 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  2 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  3 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  4 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  5 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  6 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  7 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  8 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#>  9 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
+#> 10 10.1… dois  10.17863/cam.… <df[,2] [5 … <df[,6] … <df[,1… Apollo - …
 #> # … with 15 more rows, and 38 more variables: $container$type <chr>,
 #> #   $$title <chr>, $$firstPage <chr>, $$identifier <chr>,
 #> #   $$identifierType <chr>, $publicationYear <int>, $subjects <list>,
 #> #   $contributors <list>, $dates <list>, $language <chr>, $types$ris <chr>,
-#> #   $$bibtex <chr>, $$citeproc <chr>, $$schemaOrg <chr>,
-#> #   $$resourceTypeGeneral <chr>, $$resourceType <chr>,
-#> #   $relatedIdentifiers <list>, $sizes <list>, $formats <list>, $version <chr>,
-#> #   $rightsList <list>, $descriptions <list>, $geoLocations <list>,
-#> #   $fundingReferences <list>, $url <chr>, $contentUrl <lgl>,
-#> #   $metadataVersion <int>, $schemaVersion <chr>, $source <chr>,
-#> #   $isActive <lgl>, $state <chr>, $reason <lgl>, $created <chr>,
-#> #   $registered <chr>, $published <chr>, $updated <chr>,
+#> #   $$bibtex <chr>, $$citeproc <chr>, $$schemaOrg <chr>, $$resourceType <chr>,
+#> #   $$resourceTypeGeneral <chr>, $relatedIdentifiers <list>, $sizes <list>,
+#> #   $formats <list>, $version <chr>, $rightsList <list>, $descriptions <list>,
+#> #   $geoLocations <list>, $fundingReferences <list>, $url <chr>,
+#> #   $contentUrl <lgl>, $metadataVersion <int>, $schemaVersion <chr>,
+#> #   $source <chr>, $isActive <lgl>, $state <chr>, $reason <lgl>,
+#> #   $created <chr>, $registered <chr>, $published <chr>, $updated <chr>,
 #> #   relationships$client$data$id <chr>, $$$type <chr>
 #> 
 #> $included
-#> # A tibble: 11 x 4
-#>    id    type  attributes$name $symbol $year $contactEmail $alternateName
-#>    <chr> <chr> <chr>           <chr>   <int> <chr>         <chr>         
-#>  1 cern… clie… Zenodo          CERN.Z…  2013 info@zenodo.… Research. Sha…
-#>  2 rg.rg clie… ResearchGate    RG.RG    2016 christian.sc… <NA>          
-#>  3 drya… clie… DRYAD           DRYAD.…  2018 admin@datadr… <NA>          
-#>  4 dk.a… clie… Aalborg Univer… DK.AAU   2012 [email protected] <NA>          
-#>  5 figs… clie… figshare Acade… FIGSHA…  2016 danielduduta… <NA>          
-#>  6 ethz… clie… NCCR MARVEL     ETHZ.M…  2017 doi@library.… <NA>          
-#>  7 usgs… clie… USGS DOI Tool … USGS.P…  2018 gs-css_csas_… USGS Science …
-#>  8 psnc… clie… Dolnośląska Sz… PSNC.D…  2019 anna.andrejo… <NA>          
-#>  9 cros… clie… Crossref Citat… CROSSR…  2019 info@datacit… <NA>          
-#> 10 cos.… clie… Open Science F… COS.OSF  2018 support@osf.… <NA>          
-#> 11 ornl… clie… Oak Ridge Nati… ORNLDA…  2018 doi_admin@da… <NA>          
+#> # A tibble: 7 x 4
+#>   id    type  attributes$name $symbol $year $contactEmail $alternateName
+#>   <chr> <chr> <chr>           <chr>   <int> <chr>         <chr>         
+#> 1 bl.c… clie… University of … BL.CAM   2015 support@repo… <NA>          
+#> 2 usgs… clie… USGS DOI Tool … USGS.P…  2018 gs-css_csas_… USGS Science …
+#> 3 drya… clie… DRYAD           DRYAD.…  2018 admin@datadr… <NA>          
+#> 4 rg.rg clie… ResearchGate    RG.RG    2016 christian.sc… <NA>          
+#> 5 delf… clie… TU Delft BK Bo… DELFT.…  2012 F.D.vanderHo… <NA>          
+#> 6 sage… clie… Data Planet     SAGE.D…  2018 Kari.Hemdal@… <NA>          
+#> 7 cern… clie… Zenodo          CERN.Z…  2013 info@zenodo.… Research. Sha…
 #> # … with 15 more variables: $description <chr>, $language <list>,
 #> #   $clientType <chr>, $domains <chr>, $re3data <chr>, $opendoar <lgl>,
 #> #   $issn <list>, $url <chr>, $created <chr>, $updated <chr>, $isActive <lgl>,