Skip to content

Commit

Permalink
add CITATION.cff bibtex codemeta.json
Browse files Browse the repository at this point in the history
Genuine worry: I am wondering why all these files should be specified.
They kinda contain the same information
  • Loading branch information
orchid00 committed Nov 30, 2018
1 parent d8cf8e0 commit a6c10cc
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 4 deletions.
10 changes: 10 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
cff-version: 1.0.3
message: If you use this software, please cite it as below.
authors:
- family-names: Martinez
given-names: Paula Andrea
orcid: https://orcid.org/0000-0002-8990-1985
title: Indeed web scrapping for KSAs
version: 0.1
doi: https://doi.org/
date-released: 2018-12-29
4 changes: 3 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Package: indeedKSA
Type: SoftwareSourceCode
Title: Web scrapping solution, to save job ads from indeed.com as text files and find keywords
Version: 0.1
Date: 2018-11-29
Authors@R: person("Paula Andrea", "Martinez", email = "mvpaula0@gmail.com",
role = c("aut", "cre"))
Description: This a fairly simple web scrapping solution. It saves job ads from
Expand All @@ -11,7 +13,7 @@ Description: This a fairly simple web scrapping solution. It saves job ads from
The code is written in R version 3.5.1 (2018-07-02),
using packages listed in 00_installPkgs.R,
developed on a x86_64-pc-linux-gnu platform.
Depends: R (>= 3.1.0)
Depends: R (>= 3.5.1)
License: GNU General Public License v3.0
LazyData: true
RoxygenNote: 6.1.1
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ using packages listed in 00_installPkgs.R [here][installPkgs],
developed on a x86_64-pc-linux-gnu platform.

### Where to start?
- Want to see the results?
- Want to see the results? (this is meant for users)
- If you want to see an example of results go to the `report folder`,
click [here][report] to see the notebook.


- Do it yourself (DIY) approach
- Do it yourself (DIY) approach (this is meant for contributors and developers)
- If you want to run the code in your own computer, the steps are:
- You need to download the `scripts` and the `report` folders with their
contents (all the results files are generated when running the scripts).
Expand Down Expand Up @@ -86,7 +86,7 @@ For more details see

## Citation

"Indeed web Scrapping for KSA", November 2018.
"Indeed web scrapping for KSAs" v0.1, November 2018.
[Paula Andrea Martinez](https://orcid.org/0000-0002-8990-1985) with ORCID iD
0000-0002-8990-1985.
[https://github.com/orchid00/jobWordSearch](https://github.com/orchid00/jobWordSearch).
Expand Down
6 changes: 6 additions & 0 deletions bibtex
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
@misc{,
title = "Indeed web scrapping for KSAs",
author = "Paula Andrea Martinez",
year = "2018",
url = "https://github.com/orchid00/jobWordSearch"
}
83 changes: 83 additions & 0 deletions codemeta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{
"@context": "https://doi.org/",
"@type": "SoftwareSourceCode",
"id": "@id",
"schema":"http://schema.org/",
"codemeta": "https://codemeta.github.io/terms/",
"Organization": {"@id": "schema:Organization"},
"Person": {"@id": "schema:Person"},
"SoftwareSourceCode": {"@id": "schema:SoftwareSourceCode"},
"SoftwareApplication": {"@id": "schema:SoftwareApplication"},
"Text": {"@id": "schema:Text"},
"URL": "https://orchid00.github.io/jobWordSearch/",
"address": { "@id": "schema:address"},
"affiliation": { "@id": "schema:affiliation"},
"applicationCategory": { "@id": "schema:applicationCategory", "@type": "@id"},
"applicationSubCategory": { "@id": "schema:applicationSubCategory", "@type": "@id"},
"citation": { "@id": "schema:citation"},
"codeRepository": "https://github.com/orchid00/jobWordSearch",
"contributor": { "@id": "schema:contributor"},
"copyrightHolder": { "@id": "schema:copyrightHolder"},
"copyrightYear": { "@id": "schema:copyrightYear"},
"creator": { "@id": "schema:creator"},
"dateCreated": "2018-09-01",
"dateModified": "2018-11-01",
"datePublished": "2018-11-29",
"description": "This a fairly simple web scrapping solution. It saves job ads from indeed.com as text files and then, for each job ad a search for sentences is performed and saved. After collecting the sentences, the report looks for keywords identified around knowledge skills and abilities (KSA's)",
"developmentStatus": "active",
"downloadUrl": "https://github.com/orchid00/jobWordSearch/archive/v0.1.tar.gz",
"email": { "@id": "schema:email"},
"editor": { "@id": "schema:editor"},
"encoding": { "@id": "schema:encoding"},
"familyName": { "@id": "schema:familyName"},
"fileFormat": { "@id": "schema:fileFormat", "@type": "@id"},
"fileSize": { "@id": "schema:fileSize"},
"funder": { "@id": "schema:funder"},
"givenName": { "@id": "schema:givenName"},
"hasPart": { "@id": "schema:hasPart" },
"identifier": { "@id": "schema:identifier", "@type": "@id"},
"installUrl": { "@id": "schema:installUrl", "@type": "@id"},
"isAccessibleForFree": { "@id": "schema:isAccessibleForFree"},
"isPartOf": { "@id": "schema:isPartOf"},
"keywords": { "@id": "schema:keywords"},
"license": "https://github.com/orchid00/jobWordSearch/blob/master/LICENSE.md",
"memoryRequirements": { "@id": "schema:memoryRequirements", "@type": "@id"},
"name": { "@id": "schema:name"},
"operatingSystem": { "@id": "schema:operatingSystem"},
"permissions": { "@id": "schema:permissions"},
"position": { "@id": "schema:position"},
"processorRequirements": { "@id": "schema:processorRequirements"},
"producer": { "@id": "schema:producer"},
"programmingLanguage": "R",
"provider": { "@id": "schema:provider"},
"publisher": { "@id": "schema:publisher"},
"relatedLink": { "@id": "schema:relatedLink", "@type": "@id"},
"releaseNotes": { "@id": "schema:releaseNotes", "@type": "@id"},
"runtimePlatform": { "@id": "schema:runtimePlatform"},
"sameAs": { "@id": "schema:sameAs", "@type": "@id"},
"softwareHelp": { "@id": "schema:softwareHelp"},
"softwareRequirements": { "@id": "schema:softwareRequirements", "@type": "@id"},
"softwareVersion": { "@id": "schema:softwareVersion"},
"sponsor": { "@id": "schema:sponsor"},
"storageRequirements": { "@id": "schema:storageRequirements", "@type": "@id"},
"supportingData": { "@id": "schema:supportingData"},
"targetProduct": { "@id": "schema:targetProduct"},
"url": { "@id": "schema:url", "@type": "@id"},
"version": "0.1",
"author": {
"@id": "https://orcid.org/0000-0002-8990-1985",
"@type": "Person",
"email": "mvpaula0@gmail.com",
"givenName": "Paula Andrea",
"familyName": "Martinez"
},
"maintainer": "https://orcid.org/0000-0002-8990-1985",
"softwareSuggestions": { "@id": "codemeta:softwareSuggestions", "@type": "@id"},
"contIntegration": { "@id": "codemeta:contIntegration", "@type": "@id"},
"buildInstructions": "https://orchid00.github.io/jobWordSearch/reference/index.html",
"embargoDate": { "@id":"codemeta:embargoDate", "@type": "schema:Date" },
"funding": { "@id": "codemeta:funding" },
"readme": "https://github.com/orchid00/jobWordSearch/blob/master/README.md",
"issueTracker": "https://github.com/orchid00/jobWordSearch/issues",
"referencePublication": { "@id": "codemeta:referencePublication", "@type": "@id"}
}

0 comments on commit a6c10cc

Please sign in to comment.