Skip to content

Commit e1605ae

Browse files
authored
adds feature-engine citation details (#300)
* adds DOI citation to readme * update circleci badge * adds draft citations, completes about, reorganises logos location * adds ciation to joss after acceptance
1 parent f7fae39 commit e1605ae

File tree

9 files changed

+1079
-5
lines changed

9 files changed

+1079
-5
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
![PythonVersion](https://img.shields.io/badge/python-3.6%20|3.7%20|%203.8%20|%203.9-success)
44
[![PyPI version](https://badge.fury.io/py/feature-engine.svg)](https://badge.fury.io/py/feature-engine)
55
[![License https://github.com/feature-engine/feature_engine/blob/master/LICENSE.md](https://img.shields.io/badge/license-BSD-success.svg)](https://github.com/feature-engine/feature_engine/blob/master/LICENSE.md)
6-
[![CircleCI https://app.circleci.com/pipelines/github/feature-engine/feature_engine?branch=master](https://img.shields.io/circleci/build/github/feature-engine/feature_engine/master.svg?token=5a1c2accc2c97450e52d2cb1b47c333ab495d2c2)](https://circleci.com/gh/feature-engine/feature_engine/tree/master)
6+
[![CircleCI https://app.circleci.com/pipelines/github/feature-engine/feature_engine?branch=1.1.X](https://img.shields.io/circleci/build/github/feature-engine/feature_engine)](https://app.circleci.com/pipelines/github/feature-engine/feature_engine?branch=1.1.X)
77
[![Documentation Status https://feature-engine.readthedocs.io/en/latest/index.html](https://readthedocs.org/projects/feature-engine/badge/?version=latest)](https://feature-engine.readthedocs.io/en/latest/index.html)
88
[![Join the chat at https://gitter.im/feature_engine/community](https://badges.gitter.im/feature_engine/community.svg)](https://gitter.im/feature_engine/community)
99
[![Sponsorship https://www.trainindata.com/](https://img.shields.io/badge/Powered%20By-TrainInData-orange.svg)](https://www.trainindata.com/)
1010
[![Downloads](https://pepy.tech/badge/feature-engine)](https://pepy.tech/project/feature-engine)
1111
[![Downloads](https://pepy.tech/badge/feature-engine/month)](https://pepy.tech/project/feature-engine)
1212
[![Conda https://anaconda.org/conda-forge/feature_engine](https://anaconda.org/conda-forge/feature_engine/badges/installer/conda.svg)](https://anaconda.org/conda-forge/feature_engine)
13+
[![DOI](https://zenodo.org/badge/163630824.svg)](https://zenodo.org/badge/latestdoi/163630824)
14+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03642/status.svg)](https://doi.org/10.21105/joss.03642)
1315

1416

1517
Feature-engine is a Python library with multiple transformers to engineer and select features for use in machine learning models.

docs/about.rst

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,59 @@ You can learn more about Feature-engine's Contributors in the
4141
Citing Feature-engine
4242
---------------------
4343

44-
Coming soon
44+
.. image:: https://zenodo.org/badge/163630824.svg
45+
:target: https://zenodo.org/badge/latestdoi/163630824
4546

47+
.. image:: https://joss.theoj.org/papers/10.21105/joss.03642/status.svg
48+
:target: https://joss.theoj.org/papers/10.21105/joss.03642
49+
50+
If you use Feature-engine in a scientific publication, you can cite the following paper:
51+
Galli, S., (2021). `Feature-engine: A Python package for feature engineering for machine learning. <https://joss.theoj.org/papers/10.21105/joss.03642>`_
52+
Journal of Open Source Software, 6(65), 3642.
53+
54+
Bibtex entry:
55+
56+
.. code-block:: bibtex
57+
58+
@article{Galli2021,
59+
doi = {10.21105/joss.03642},
60+
url = {https://doi.org/10.21105/joss.03642},
61+
year = {2021},
62+
publisher = {The Open Journal},
63+
volume = {6},
64+
number = {65},
65+
pages = {3642},
66+
author = {Soledad Galli},
67+
title = {Feature-engine: A Python package for feature engineering for machine learning},
68+
journal = {Journal of Open Source Software}
69+
}
70+
71+
72+
73+
You can also find a DOI (digital object identifier) for every version of Feature-engine
74+
on `zenodo.org <https://zenodo.org/badge/latestdoi/163630824>`_; use the BibTeX on this
75+
site to reference specific versions of the software.
76+
77+
78+
Artwork
79+
-------
80+
81+
High quality PNG and SVG logos are available in the `docs/images/ <https://github.com/feature-engine/feature_engine/tree/main/docs/images/logo>`_
82+
source directory of the repository.
83+
84+
.. figure:: images/logo/FeatureEngine.png
85+
:align: center
86+
87+
88+
Sponsors
89+
--------
90+
91+
Feature-engine is a community driven project, however institutional and private grants
92+
help to assure its sustainability.
93+
94+
The project would like to thank the following sponsors:
95+
96+
Soledad Galli spends a big part of her time at Train in Data maintaining the project.
97+
98+
.. image:: images/sponsors/trainindata.png
99+
:target: https://www.trainindata.com/

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,12 +160,12 @@
160160

161161
# The name of an image file (relative to this directory) to place at the top
162162
# of the sidebar.
163-
html_logo = "images/Logo.png"
163+
html_logo = "images/logo/Logo.png"
164164

165165
# The name of an image file (within the static path) to use as favicon of the
166166
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
167167
# pixels large.
168-
html_favicon = "images/favicon.png"
168+
html_favicon = "images/logo/favicon.png"
169169

170170
# Add any paths that contain custom static files (such as style sheets) here,
171171
# relative to this directory. They are copied after the builtin static files,
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)